summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-12-06 08:58:57 -0500
committerFrederic Guillot <fred@kanboard.net>2015-12-06 08:58:57 -0500
commit28c8af70f4dc18f364096b1867deb74af6ae3723 (patch)
treeee8b268560786ea4aa33e51aba07b6ce66fd05cd
parentfd16ea680f90d09ada80bc42cefd1b21deb37844 (diff)
Add doc for user types
-rw-r--r--README.md2
-rw-r--r--doc/index.markdown3
-rw-r--r--doc/user-types.markdown14
3 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index 100f412f..b28ac3e8 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
Kanboard
========
-Kanboard is a project management software that use the Kanban methodology.
+Kanboard is a project management software that uses the Kanban methodology.
Official website: <http://kanboard.net>
diff --git a/doc/index.markdown b/doc/index.markdown
index de23f5f4..801a90e4 100644
--- a/doc/index.markdown
+++ b/doc/index.markdown
@@ -19,7 +19,7 @@ Using Kanboard
### Working with projects
-- [project-types](project-types.markdown)
+- [Project Types](project-types.markdown)
- [Creating projects](creating-projects.markdown)
- [Editing projects](editing-projects.markdown)
- [Sharing boards and tasks](sharing-projects.markdown)
@@ -49,6 +49,7 @@ Using Kanboard
### Working with users
- [Roles](roles.markdown)
+- [User Types](user-types.markdown)
- [User management](user-management.markdown)
- [Notifications](notifications.markdown)
- [Two factor authentication](2fa.markdown)
diff --git a/doc/user-types.markdown b/doc/user-types.markdown
new file mode 100644
index 00000000..8c88a7dd
--- /dev/null
+++ b/doc/user-types.markdown
@@ -0,0 +1,14 @@
+User Types
+==========
+
+In Kanboard there are two types of users:
+
+| Type | Description |
+|---------------|-----------------------------------------------------------------------|
+| Local User | User that stores his password in Kanboard's database |
+| Remote User | User credentials are managed by another system (Example: LDAP server) |
+
+Examples of remote users:
+
+- LDAP user
+- Users authenticated by a reverse-proxy