summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-07-18 10:32:29 -0400
committerFrederic Guillot <fred@kanboard.net>2015-07-18 10:32:29 -0400
commitd75a0a9d455c01b6845dcc2ea7d61d55d416766b (patch)
tree24fd0f52a8f17ab28b13d4ad3cad48dd80a9b540
parentde109aaeafde6a375441970bcb40136cdb7dff45 (diff)
Update doc of users
-rw-r--r--docs/user-management.markdown16
1 files changed, 12 insertions, 4 deletions
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
![New user](http://kanboard.net/screenshots/documentation/new-user.png)
-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
----------