Update documentation
This commit is contained in:
Frederic Guillot
parent
839a0d831e
commit
8d24e03b44
|
|
@ -19,7 +19,6 @@ New features:
|
|||
* Added current values when moving/duplicate a task to another project and add a loading icon
|
||||
* Added memory consumption in debug log
|
||||
* Added form to create remote user
|
||||
* Added option to disable automatic LDAP user creation
|
||||
* Added edit form for user authentication
|
||||
* Added config option to hide login form
|
||||
* Display OAuth2 urls on integration page
|
||||
|
|
@ -95,4 +94,3 @@ Version 1.0.0 to 1.0.16
|
|||
-----------------------
|
||||
|
||||
* See commit history and website news
|
||||
|
||||
|
|
|
|||
|
|
@ -24,6 +24,7 @@ Cumulative flow diagram
|
|||
|
||||
- This chart show the number of tasks cumulatively for each column over the time.
|
||||
- Everyday, the total number of tasks is recorded for each column.
|
||||
- If you would like to exclude closed tasks, change the [global project settings](project-configuration.markdown).
|
||||
|
||||
Note: You need to have at least 2 days of data to see the graph.
|
||||
|
||||
|
|
|
|||
|
|
@ -34,3 +34,7 @@ Kanboard offer 3 different choices:
|
|||
- YYYY/MM/DD
|
||||
|
||||
The [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format is always accepted (YYYY-MM-DD or YYYY_MM_DD).
|
||||
|
||||
### Custom Stylesheet
|
||||
|
||||
Write your own CSS to override or improve Kanboard default style.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,19 @@
|
|||
Collapsed and Expanded mode
|
||||
===========================
|
||||
|
||||
Tasks on the board can be displayed in collapsed or in expanded mode.
|
||||
Switching from one view to another can be done with the keyboard shortcut **"s"** or by using the dropdown menu on the left.
|
||||
|
||||
Collapsed mode
|
||||
--------------
|
||||
|
||||
|
||||
|
||||
- If the task is assigned to someone, the initials of the person are shown next to the task number
|
||||
- If the task title is too long, you can put your mouse over the task to show a tooltip with the full title.
|
||||
|
||||
Expanded mode
|
||||
-------------
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
Horizontal scrolling and compact mode
|
||||
=====================================
|
||||
|
||||
When the board can't fit on your screen, an horizontal scroll bar will appear at the bottom.
|
||||
|
||||
However, it's possible to switch to the compact the view to display all columns in your screen.
|
||||
|
||||
|
||||
|
||||
Switching between horizontal scrolling and compact view can be done with the keyboard shortcut **"c"** or by using the dropdown menu on the top left.
|
||||
|
||||
Note: It's possible that text overlaps in compact mode, that will be improved over the next releases.
|
||||
|
|
@ -28,17 +28,21 @@ chown -R apache:apache kanboard/data
|
|||
rm kanboard-latest.zip
|
||||
```
|
||||
|
||||
If SeLinux is enabled, be sure that the Apache user can write to the directory data:
|
||||
If SELinux is enabled, be sure that the Apache user can write to the directory data:
|
||||
|
||||
```bash
|
||||
chcon -R -t httpd_sys_content_rw_t /var/www/html/kanboard/data
|
||||
```
|
||||
|
||||
Be sure to configure your server to allow Kanboard to send emails and make external HTTP requests.
|
||||
Be sure to configure your server to allow Kanboard to send emails and make external network requests, by example with SELinux:
|
||||
|
||||
You can also disable SeLinux if you don't need it.
|
||||
```bash
|
||||
setsebool -P httpd_can_network_connect=1
|
||||
```
|
||||
|
||||
Centos 6.5
|
||||
Allowing external connections is necessary if you use LDAP, SMTP, Webhooks or any third-party integrations.
|
||||
|
||||
Centos 6.x
|
||||
----------
|
||||
|
||||
Install PHP and Apache:
|
||||
|
|
|
|||
|
|
@ -56,8 +56,8 @@ Pull-requests are always welcome, however to be accepted you have to follow thos
|
|||
- If you want to add a new feature, respect the philosophy behind Kanboard. **We focus on simplicity**, we don't want to have a bloated software.
|
||||
- The same apply for the user interface, **simplicity and efficiency**.
|
||||
- Send only one pull-request per feature or bug fix, your patch will be merged into one single commit in the master branch.
|
||||
- Make sure the [unit tests pass](http://kanboard.net/documentation/tests).
|
||||
- Respect the [coding standards](http://kanboard.net/documentation/coding-standards).
|
||||
- Make sure the [unit tests pass](tests.markdown).
|
||||
- Respect the [coding standards](coding-standards.makrdown).
|
||||
- Write maintainable code, avoid code duplication, use PHP good practices.
|
||||
|
||||
In any case, if you are not sure about something open a new ticket.
|
||||
|
|
|
|||
|
|
@ -10,6 +10,12 @@ Using Kanboard
|
|||
- [Kanban vs Todo Lists and Scrum](kanban-vs-todo-and-scrum.markdown)
|
||||
- [Usage examples](usage-examples.markdown)
|
||||
|
||||
### Using the board
|
||||
|
||||
- [Board, Calendar and List views](project-views.markdown)
|
||||
- [Collapsed and expended mode](board-collapsed-expanded.markdown)
|
||||
- [Horizontal scrolling and compact mode](board-horizontal-scrolling-and-compact-view.markdown)
|
||||
|
||||
### Working with projects
|
||||
|
||||
- [Creating projects](creating-projects.markdown)
|
||||
|
|
@ -53,7 +59,6 @@ Using Kanboard
|
|||
- [Calendar settings](calendar-configuration.markdown)
|
||||
- [Link settings](link-labels.markdown)
|
||||
- [Currency rate](currency-rate.markdown)
|
||||
- [Config file](config.markdown)
|
||||
|
||||
### Integrations
|
||||
|
||||
|
|
@ -98,6 +103,7 @@ Technical details
|
|||
|
||||
### Configuration
|
||||
|
||||
- [Config file](config.markdown)
|
||||
- [Email configuration](email-configuration.markdown)
|
||||
- [URL rewriting](nice-urls.markdown)
|
||||
|
||||
|
|
|
|||
|
|
@ -5,8 +5,8 @@ Requirements
|
|||
------------
|
||||
|
||||
- Apache or Nginx
|
||||
- PHP >= 5.3.7
|
||||
- PHP extensions required: mbstring, gd and pdo_sqlite (don't forget to enable extensions)
|
||||
- PHP >= 5.3.3 (Kanboard is compatible with PHP 5.3, 5.4, 5.5, 5.6 and 7.0)
|
||||
- PHP extensions required: mbstring, gd and pdo_sqlite
|
||||
- A modern web browser
|
||||
|
||||
From the archive (stable version)
|
||||
|
|
|
|||
|
|
@ -30,4 +30,5 @@ Now, Kanboard events will be sent to the Jabber conference room.
|
|||
|
||||
## Troubleshooting
|
||||
|
||||
- Enable the debug mode
|
||||
- All connection errors with the XMPP server are recorded in the log files `data/debug.log` or syslog
|
||||
|
|
|
|||
|
|
@ -1,15 +1,24 @@
|
|||
Keyboard shortcuts
|
||||
==================
|
||||
|
||||
Board/Calendar/List view
|
||||
------------------------
|
||||
|
||||
- Switch to the board view = **v b**
|
||||
- Switch to the calendar view = **v c**
|
||||
- Switch to the list view = **v l**
|
||||
|
||||
Board view
|
||||
----------
|
||||
|
||||
- New task = **n**
|
||||
- Expand/collapse tasks = **s**
|
||||
- Compact/wide view = **c**
|
||||
|
||||
Application
|
||||
-----------
|
||||
|
||||
- Open board switcher = **b**
|
||||
- Go to the search/filter box = **f**
|
||||
- Close dialog box = **ESC**
|
||||
- Submit a form = **CTRL+ENTER** or **⌘+ENTER**
|
||||
- Submit a form = **CTRL+ENTER** or **⌘+ENTER**
|
||||
|
|
@ -34,75 +34,6 @@ Configuration
|
|||
You have to create a custom config file named `config.php` (you can also use the template `config.default.php`).
|
||||
This file must be stored in the root directory of Kanboard.
|
||||
|
||||
### Available configuration parameters
|
||||
|
||||
```php
|
||||
// Enable LDAP authentication (false by default)
|
||||
define('LDAP_AUTH', false);
|
||||
|
||||
// LDAP server hostname
|
||||
define('LDAP_SERVER', '');
|
||||
|
||||
// LDAP server port (389 by default)
|
||||
define('LDAP_PORT', 389);
|
||||
|
||||
// By default, require certificate to be verified for ldaps:// style URL. Set to false to skip the verification.
|
||||
define('LDAP_SSL_VERIFY', true);
|
||||
|
||||
// Enable LDAP START_TLS
|
||||
define('LDAP_START_TLS', false);
|
||||
|
||||
// LDAP bind type: "anonymous", "user" (use the given user/password from the form) and "proxy" (a specific user to browse the LDAP directory)
|
||||
define('LDAP_BIND_TYPE', 'anonymous');
|
||||
|
||||
// LDAP username to connect with. null for anonymous bind (by default).
|
||||
// Or for user bind type, you can use a pattern like that %s@kanboard.local
|
||||
define('LDAP_USERNAME', null);
|
||||
|
||||
// LDAP password to connect with. null for anonymous bind (by default).
|
||||
define('LDAP_PASSWORD', null);
|
||||
|
||||
// LDAP account base, i.e. root of all user account
|
||||
// Example: ou=People,dc=example,dc=com
|
||||
define('LDAP_ACCOUNT_BASE', '');
|
||||
|
||||
// LDAP query pattern to use when searching for a user account
|
||||
// Example for ActiveDirectory: '(&(objectClass=user)(sAMAccountName=%s))'
|
||||
// Example for OpenLDAP: 'uid=%s'
|
||||
define('LDAP_USER_PATTERN', '');
|
||||
|
||||
// Name of an attribute of the user account object which should be used as the full name of the user.
|
||||
define('LDAP_ACCOUNT_FULLNAME', 'displayname');
|
||||
|
||||
// Name of an attribute of the user account object which should be used as the email of the user.
|
||||
define('LDAP_ACCOUNT_EMAIL', 'mail');
|
||||
|
||||
// Name of an attribute of the user account object which should be used as the id of the user.
|
||||
// Example for ActiveDirectory: 'samaccountname'
|
||||
// Example for OpenLDAP: 'uid'
|
||||
define('LDAP_ACCOUNT_ID', 'samaccountname');
|
||||
|
||||
// By default Kanboard lowercase the ldap username to avoid duplicate users (the database is case sensitive)
|
||||
// Set to true if you want to preserve the case
|
||||
define('LDAP_USERNAME_CASE_SENSITIVE', false);
|
||||
|
||||
// Automatically create user account
|
||||
define('LDAP_ACCOUNT_CREATION', true);
|
||||
```
|
||||
|
||||
### Disable automatic account creation
|
||||
|
||||
By default, Kanboard will create automatically a user account if nothing is found.
|
||||
|
||||
You can disable this behavior if you prefer to create user accounts manually to restrict Kanboard to only some people.
|
||||
|
||||
Just change the value of `LDAP_ACCOUNT_CREATION` to `false`:
|
||||
|
||||
```php
|
||||
// Automatically create user account
|
||||
define('LDAP_ACCOUNT_CREATION', false);
|
||||
```
|
||||
|
||||
### LDAP bind type
|
||||
|
||||
There is 3 possible ways to browse the LDAP directory:
|
||||
|
|
@ -202,7 +133,7 @@ define('LDAP_ACCOUNT_EMAIL', 'mail');
|
|||
|
||||
### Example for OpenLDAP
|
||||
|
||||
Here, our LDAP server is `myserver.example.com` and all users are stored in the hierarchy `ou=People,dc=example,dc=com`.
|
||||
Our LDAP server is `myserver.example.com` and all users are stored in the hierarchy `ou=People,dc=example,dc=com`.
|
||||
|
||||
For this example with use the anonymous binding.
|
||||
|
||||
|
|
@ -222,4 +153,82 @@ define('LDAP_ACCOUNT_FULLNAME', 'displayname');
|
|||
define('LDAP_ACCOUNT_EMAIL', 'mail');
|
||||
```
|
||||
|
||||
The `%s` is replaced by the username for the parameter `LDAP_USER_PATTERN`, so you can define a custom Distinguished Name.
|
||||
The `%s` is replaced by the username for the parameter `LDAP_USER_PATTERN`, so you can define a custom Distinguished Name (example: ` (&(objectClass=user)(uid=%s)(!(ou:dn::=trainees)))`).
|
||||
|
||||
### Disable automatic account creation
|
||||
|
||||
By default, Kanboard will create automatically a user account if nothing is found.
|
||||
|
||||
You can disable this behavior if you prefer to create user accounts manually to restrict Kanboard to only some people.
|
||||
|
||||
Just change the value of `LDAP_ACCOUNT_CREATION` to `false`:
|
||||
|
||||
```php
|
||||
// Automatically create user account
|
||||
define('LDAP_ACCOUNT_CREATION', false);
|
||||
```
|
||||
|
||||
### SELinux on RHEL-based like CentOS
|
||||
|
||||
If SELinux is enabled, you have to allow Apache to reach out your LDAP server.
|
||||
|
||||
- You can switch SELinux to the permissive mode or disable it (not recomemnded)
|
||||
- You can allow all network connections, by example `setsebool -P httpd_can_network_connect=1` or have a more restrictive rule
|
||||
|
||||
In any case, refer to the official Redhat/Centos documentation.
|
||||
|
||||
### Available configuration parameters
|
||||
|
||||
```php
|
||||
// Enable LDAP authentication (false by default)
|
||||
define('LDAP_AUTH', false);
|
||||
|
||||
// LDAP server hostname
|
||||
define('LDAP_SERVER', '');
|
||||
|
||||
// LDAP server port (389 by default)
|
||||
define('LDAP_PORT', 389);
|
||||
|
||||
// By default, require certificate to be verified for ldaps:// style URL. Set to false to skip the verification.
|
||||
define('LDAP_SSL_VERIFY', true);
|
||||
|
||||
// Enable LDAP START_TLS
|
||||
define('LDAP_START_TLS', false);
|
||||
|
||||
// LDAP bind type: "anonymous", "user" (use the given user/password from the form) and "proxy" (a specific user to browse the LDAP directory)
|
||||
define('LDAP_BIND_TYPE', 'anonymous');
|
||||
|
||||
// LDAP username to connect with. null for anonymous bind (by default).
|
||||
// Or for user bind type, you can use a pattern like that %s@kanboard.local
|
||||
define('LDAP_USERNAME', null);
|
||||
|
||||
// LDAP password to connect with. null for anonymous bind (by default).
|
||||
define('LDAP_PASSWORD', null);
|
||||
|
||||
// LDAP account base, i.e. root of all user account
|
||||
// Example: ou=People,dc=example,dc=com
|
||||
define('LDAP_ACCOUNT_BASE', '');
|
||||
|
||||
// LDAP query pattern to use when searching for a user account
|
||||
// Example for ActiveDirectory: '(&(objectClass=user)(sAMAccountName=%s))'
|
||||
// Example for OpenLDAP: 'uid=%s'
|
||||
define('LDAP_USER_PATTERN', '');
|
||||
|
||||
// Name of an attribute of the user account object which should be used as the full name of the user.
|
||||
define('LDAP_ACCOUNT_FULLNAME', 'displayname');
|
||||
|
||||
// Name of an attribute of the user account object which should be used as the email of the user.
|
||||
define('LDAP_ACCOUNT_EMAIL', 'mail');
|
||||
|
||||
// Name of an attribute of the user account object which should be used as the id of the user.
|
||||
// Example for ActiveDirectory: 'samaccountname'
|
||||
// Example for OpenLDAP: 'uid'
|
||||
define('LDAP_ACCOUNT_ID', 'samaccountname');
|
||||
|
||||
// By default Kanboard lowercase the ldap username to avoid duplicate users (the database is case sensitive)
|
||||
// Set to true if you want to preserve the case
|
||||
define('LDAP_USERNAME_CASE_SENSITIVE', false);
|
||||
|
||||
// Automatically create user account
|
||||
define('LDAP_ACCOUNT_CREATION', true);
|
||||
```
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ You can use the service [Mailgun](http://www.mailgun.com/) to create tasks direc
|
|||
This integration works with the inbound email service of Mailgun (routes).
|
||||
Kanboard use a webhook to handle incoming emails.
|
||||
|
||||
The [incoming email workflow is described here](http://kanboard.net/documentation/email-tasks).
|
||||
The [incoming email workflow is described here](create-tasks-by-email.markdown).
|
||||
|
||||
Mailgun configuration
|
||||
---------------------
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ You can use the service [Postmark](https://postmarkapp.com/) to create tasks dir
|
|||
This integration works with the inbound email service of Postmark.
|
||||
Kanboard use a webhook to handle incoming emails.
|
||||
|
||||
The [incoming email workflow is described here](http://kanboard.net/documentation/email-tasks).
|
||||
The [incoming email workflow is described here](create-tasks-by-email.markdown).
|
||||
|
||||
Postmark configuration
|
||||
----------------------
|
||||
|
|
|
|||
|
|
@ -29,3 +29,14 @@ If another subtask have the status "in progress", the user will see this dialog
|
|||
|
||||
|
||||
|
||||
### Trigger automatically subtask time tracking
|
||||
|
||||
- If enabled, when a subtask status is changed to "in progress", the timer will start automatically.
|
||||
- Disable this option if you don't use time tracking.
|
||||
|
||||
### Include closed tasks in the cumulative flow diagram
|
||||
|
||||
- If enabled, closed tasks will be included in the cumulative flow diagram.
|
||||
- If disabled, only open tasks will be included.
|
||||
- This option affect the column "total" of the table "project_daily_column_stats"
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,37 @@
|
|||
Board, Calendar and List views
|
||||
==============================
|
||||
|
||||
For each project, tasks can be visualized with several views: **Board, Calendar and List**. Each view show the result of the filter box at the top. The search engine use the [advanced syntax](search.markdown).
|
||||
|
||||
Board view
|
||||
----------
|
||||
|
||||
|
||||
|
||||
- With this view you can drag and drop tasks between columns easily.
|
||||
- You can also use the keyboard shortcut **"v b"** to switch to the board view.
|
||||
- Tasks with a shadow are recently modified.
|
||||
|
||||
|
||||
|
||||
When the task limit is reached for a column, the background becomes red. That means there are too many tasks in progress at the same time.
|
||||
|
||||
[Learn more about board configuration](board-configuration.markdown)
|
||||
|
||||
Calendar view
|
||||
--------------
|
||||
|
||||
|
||||
|
||||
- With this view you can visualize tasks with a due date.
|
||||
- Depending of the settings, you can also see tasks in progress.
|
||||
- You can also use the keyboard shortcut **"v c"** to switch to the calendar view.
|
||||
- [Learn more about calendar configuration](calendar-configuration.markdown)
|
||||
|
||||
List view
|
||||
--------------
|
||||
|
||||
|
||||
|
||||
- With this view all results of your search are displayed in a table.
|
||||
- You can also use the keyboard shortcut **"v l"** to switch to the list view.
|
||||
|
|
@ -5,7 +5,7 @@ Server side
|
|||
-----------
|
||||
|
||||
- Modern Linux/Unix operating system: **Ubuntu/Debian or FreeBSD**
|
||||
- Most recent version of PHP and Apache
|
||||
- Most recent version of PHP and Apache (Kanboard is compatible with PHP 5.3, 5.4, 5.5, 5.6 and 7.0)
|
||||
- Use the Sqlite database only when you have a disk with fast I/O (SSD disks) otherwise use Mysql or Postgresql
|
||||
|
||||
Client side
|
||||
|
|
@ -22,7 +22,7 @@ The following configurations are tested with Kanboard but that doesn't mean all
|
|||
|
||||
- Ubuntu 14.04 LTS
|
||||
- Debian 6, 7 and 8
|
||||
- Centos 6.5 and 7.0
|
||||
- Centos 6.x and 7.0
|
||||
- Windows 2012 Server
|
||||
- Windows 2008 Server
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ You can use the service [Sendgrid](https://sendgrid.com/) to create tasks direct
|
|||
This integration works with the [Parse API of Sendgrid](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
|
||||
Kanboard use a webhook to handle incoming emails.
|
||||
|
||||
The [incoming email workflow is described here](http://kanboard.net/documentation/email-tasks).
|
||||
The [incoming email workflow is described here](create-tasks-by-email.markdown).
|
||||
|
||||
Sendgrid configuration
|
||||
----------------------
|
||||
|
|
|
|||
Loading…
Reference in New Issue