From ddaf3917911e1f33b82d832698799b1160cebc6d Mon Sep 17 00:00:00 2001 From: Frédéric Guillot Date: Thu, 6 Mar 2014 21:50:19 -0500 Subject: Start to write some documentation about users management --- README.markdown | 6 ++++++ docs/manage-users.markdown | 45 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 docs/manage-users.markdown diff --git a/README.markdown b/README.markdown index ef0ef627..2d562c71 100644 --- a/README.markdown +++ b/README.markdown @@ -57,12 +57,18 @@ There is also many people who have reported bugs or proposed awesome ideas. Documentation ------------- +### Technical details + - [Installation instructions](docs/installation.markdown) - [Installation on Debian](docs/debian-installation.markdown) - [Upgrade Kanboard to a new version](docs/update.markdown) - [How to use Kanboard with Vagrant](docs/vagrant.markdown) - [Webhooks](docs/webhooks.markdown) +### Using Kanboard + +- [Manage users](docs/manage-users.markdown) + The documentation is written in [Markdown](http://en.wikipedia.org/wiki/Markdown). If you want to improve the documentation, just send a pull-request. diff --git a/docs/manage-users.markdown b/docs/manage-users.markdown new file mode 100644 index 00000000..13a975bf --- /dev/null +++ b/docs/manage-users.markdown @@ -0,0 +1,45 @@ +Manage users +============ + +Type of users +------------- + +Kanboard use a basic permission system, there is two kind of users: + +- Administrators +- Regular/Standard users + +Administrator have access to everything. By example, they can add or remove projects. + +A standard user can't manage users and projects. + +Add a new user +-------------- + +To add a new user, you must be administrator. + +1. Go to the top menu **users** +2. On the left, you have a link **New user** +3. Fill the form and save + +When you create a new user, you have to specify those values: + +- **username**: This is the unique identifier of your user (login) +- **password**: The password of your user must have at least 6 characters + +Eventually, you can choose to assign a default project to this user and allow him to be administrator. + +Edit users +---------- + +When you go to the **users** menu, you have the list of users, to modify a user click on the **edit link**. + +- If you are a regular user, you can change only your own profile +- You have to be administrator to be able to edit any users + +Remove users +------------ + +From the **users** menu, click on the link **remove**. This link is visible only if you are administrator. + +If you remove a specific user, **tasks assigned to this person will be unassigned** after the operation. -- cgit v1.2.3