diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config.markdown | 3 | ||||
| -rw-r--r-- | docs/ldap-authentication.markdown | 18 | ||||
| -rw-r--r-- | docs/search.markdown | 20 | ||||
| -rw-r--r-- | docs/user-management.markdown | 16 |
4 files changed, 48 insertions, 9 deletions
diff --git a/docs/config.markdown b/docs/config.markdown index aca605ca..45ba7a91 100644 --- a/docs/config.markdown +++ b/docs/config.markdown @@ -135,6 +135,9 @@ 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); ``` Google Authentication settings diff --git a/docs/ldap-authentication.markdown b/docs/ldap-authentication.markdown index 2428194d..8c7e5ff5 100644 --- a/docs/ldap-authentication.markdown +++ b/docs/ldap-authentication.markdown @@ -17,7 +17,7 @@ When the LDAP authentication is activated, the login process work like that: 1. Try first to authenticate the user by using the database 2. If the user is not found inside the database, a LDAP authentication is performed -3. If the LDAP authentication is successful, a local user is created automatically with no password and marked as LDAP user. +3. If the LDAP authentication is successful, by default a local user is created automatically with no password and marked as LDAP user. ### Differences between a local user and a LDAP user are the following: @@ -85,6 +85,22 @@ 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 diff --git a/docs/search.markdown b/docs/search.markdown index 3d00b158..4674a07e 100644 --- a/docs/search.markdown +++ b/docs/search.markdown @@ -63,6 +63,8 @@ Query for my assigned tasks assignee:me ``` +Note: Results will also include subtasks assignee with the status todo or in progress. + Search by color --------------- @@ -125,6 +127,13 @@ Attribute: **description** Example: `description:"text search"` +Search by external reference +---------------------------- + +The task reference is an external id of your task, by example a ticket number from another software. + +- Find tasks with a reference: `ref:1234` or `reference:TICKET-1234` + Search by category ------------------ @@ -151,9 +160,12 @@ Attribute: **column** - Find tasks by column name: `column:"Work in progress"` - Find tasks for several columns: `column:"Backlog" column:ready` -Search by external reference ----------------------------- +Search by swimlane +------------------ -The task reference is an external id of your task, by example a ticket number from another software. +Attribute: **swimlane** + +- Find tasks by swimlane: `swimlane:"Version 42"` +- Find tasks in the default swimlane: `swimlane:default` +- Find tasks into several swimlanes: `swimlane:"Version 1.2" swimlane:"Version 1.3"` -- Find tasks with a reference: `ref:1234` or `reference:TICKET-1234` diff --git a/docs/user-management.markdown b/docs/user-management.markdown index bd9cdb17..98691ddd 100644 --- a/docs/user-management.markdown +++ b/docs/user-management.markdown @@ -1,8 +1,8 @@ User management =============== -Type of users -------------- +Group of users +-------------- Kanboard use a basic permission system, there is two kind of users: @@ -18,22 +18,30 @@ There is also permissions defined at the project level, users can be seen as: Project managers have more privileges than a simple user member. +Local and remote users +---------------------- + +- A local user is an account that use the database to store credentials. Local users use the login form for the authentication. +- A remote user is an account that use an external system to store credentials. By example, it can be LDAP, Github or Google accounts. Authentication of these users can be done through the login form or not. + Add a new user -------------- To add a new user, you must be administrator. 1. From the dashboard, go to the menu **User Management** -2. On the top, you have a link **New user** +2. On the top, you have a link **New local user** or **New remote user** 3. Fill the form and save  -When you create a new user, you have to specify at least those values: +When you create a **local user**, you have to specify at least those values: - **username**: This is the unique identifier of your user (login) - **password**: The password of your user must have at least 6 characters +For **remote users**, only the username is mandatory. You can also pre-link Github or Google accounts if you already know their unique id. + Edit users ---------- |