From d97e1bd4cfd013b54e72f446a0e5934fff559781 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Guillot?= Date: Sun, 26 Oct 2014 19:58:47 -0400 Subject: [PATCH] Update documentation --- README.markdown | 9 +++- app/Template/config_application.php | 2 +- app/Template/project_users.php | 2 +- assets/css/app.css | 9 ++++ docs/application-configuration.markdown | 36 +++++++++++++ docs/board-configuration.markdown | 52 +++++++++++-------- docs/centos-installation.markdown | 2 + docs/cli.markdown | 2 +- docs/creating-projects.markdown | 18 ++++++- docs/creating-tasks.markdown | 1 + docs/email-configuration.markdown | 7 +-- docs/github-authentication.markdown | 14 ++--- docs/installation.markdown | 4 +- docs/ldap-authentication.markdown | 9 ++-- docs/mysql-configuration.markdown | 6 +-- docs/project-permissions.markdown | 14 +++++ docs/reverse-proxy-authentication.markdown | 34 ++++++++---- docs/tests.markdown | 4 +- docs/translations.markdown | 6 +-- docs/update.markdown | 3 ++ ...sers.markdown => user-management.markdown} | 0 docs/webhooks.markdown | 4 +- docs/windows-iis-installation.markdown | 2 +- 23 files changed, 172 insertions(+), 68 deletions(-) create mode 100644 docs/application-configuration.markdown create mode 100644 docs/project-permissions.markdown rename docs/{manage-users.markdown => user-management.markdown} (100%) diff --git a/README.markdown b/README.markdown index c8650a9ca..3375ffd23 100644 --- a/README.markdown +++ b/README.markdown @@ -60,6 +60,7 @@ Documentation - [Editing projects](docs/editing-projects.markdown) - [Sharing boards and tasks](docs/sharing-projects.markdown) - [Automatic actions](docs/automatic-actions.markdown) +- [Project permissions](docs/project-permissions.markdown) #### Working with tasks @@ -67,7 +68,12 @@ Documentation #### Working with users -- [User management](docs/manage-users.markdown) +- [User management](docs/user-management.markdown) + +#### Settings + +- [Application settings](docs/application-configuration.markdown) +- [Board settings](docs/board-configuration.markdown) #### More @@ -104,7 +110,6 @@ Documentation #### Developers and sysadmins -- [Board configuration](docs/board-configuration.markdown) - [Email configuration](docs/email-configuration.markdown) - [Command line interface](docs/cli.markdown) - [Json-RPC API](docs/api-json-rpc.markdown) diff --git a/app/Template/config_application.php b/app/Template/config_application.php index 97071bd01..c92975bc6 100644 --- a/app/Template/config_application.php +++ b/app/Template/config_application.php @@ -7,7 +7,7 @@ -
+

diff --git a/app/Template/project_users.php b/app/Template/project_users.php index 35079df61..1e1f259fd 100644 --- a/app/Template/project_users.php +++ b/app/Template/project_users.php @@ -9,7 +9,7 @@
-
+

    $username): ?> diff --git a/assets/css/app.css b/assets/css/app.css index c767cab15..8ed38ea4b 100644 --- a/assets/css/app.css +++ b/assets/css/app.css @@ -364,6 +364,15 @@ input.form-date { border-color: #ddd; } +.alert ul { + margin-top: 10px; + margin-bottom: 10px; +} + +.alert li { + margin-left: 25px; +} + /* labels */ a.label { text-decoration: none; diff --git a/docs/application-configuration.markdown b/docs/application-configuration.markdown new file mode 100644 index 000000000..f08e665f1 --- /dev/null +++ b/docs/application-configuration.markdown @@ -0,0 +1,36 @@ +Application settings +==================== + +Some parameters for the application can be changed on the settings page. +Only administrators can change those settings. + +Go to the menu **Settings**, then choose **Application settings** on the left. + +![Application settings](http://kanboard.net/screenshots/documentation/application-settings.png) + +### Application URL + +This parameter is used for email notifications. +The email footer will contains a link to the Kanboard task. + +### Language + +The application language can be changed at anytime. +The language will be set for all users. + +### Timezone + +By default, Kanboard use UTC as timezone, but you can define your own timezone. +The list contains all supported timezones by your web server. + +### Date format + +Input format used for date fields, by example the due date for tasks. + +Kanboard offer 3 different choices: + +- DD/MM/YYYY +- MM/DD/YYYY (default) +- YYYY/MM/DD + +The [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format is always accepted (YYYY-MM-DD or YYYY_MM_DD). diff --git a/docs/board-configuration.markdown b/docs/board-configuration.markdown index cc5979827..d1f74f0dd 100644 --- a/docs/board-configuration.markdown +++ b/docs/board-configuration.markdown @@ -1,30 +1,36 @@ -Board configuration -=================== +Board settings +=============== -Some parameters for the boards can be changed with a config file. +Some parameters for boards can be changed on the settings page. +Only administrators can change those settings. -Default values are available in the file `config.default.php`. -If you want to override the default values, you have to create a config file `config.php` in the root directory of your Kanboard installation. +Go to the menu **Settings**, then choose **Board settings** on the left. -### Auto-refresh frequency for the public board view - -```php -// Auto-refresh frequency in seconds for the public board view (60 seconds by default) -define('BOARD_PUBLIC_CHECK_INTERVAL', 60); -``` - -### Auto-refresh frequency for the board (Ajax polling) - -```php -// Board refresh frequency in seconds (the value 0 disable this feature, 10 seconds by default) -define('BOARD_CHECK_INTERVAL', 10); -``` +![Board settings](http://kanboard.net/screenshots/documentation/board-settings.png) ### Task highlighting -Display a shadow around the task when a task was moved recently. Set the value 0 to disable this feature. +This feature display a shadow around the task when a task is moved recently. -```php -// Period (in seconds) to consider a task was modified recently (0 to disable, 2 days by default) -define('RECENT_TASK_PERIOD', 48*60*60); -``` +Set the value 0 to disable this feature, 2 days by default (172800 seconds). + +Everything moved since 2 days will have shadow around the task. + +### Refresh interval for public board + +When you share a board, the page will refresh automatically every 60 seconds by default. + +### Refresh interval for private board + +When your web browser is open on a board, Kanboard check every 10 seconds if something have been changed by someone else. + +Technically this process is done by Ajax polling. + +### Default columns for new projects + +You can change the default column names here. +It's useful if you always create projects with the same columns. + +Each column name must be separated by a comma. + +By default, Kanboard use those column names: Backlog, Ready, Work in progress and Done. diff --git a/docs/centos-installation.markdown b/docs/centos-installation.markdown index ccffa0526..316166ae8 100644 --- a/docs/centos-installation.markdown +++ b/docs/centos-installation.markdown @@ -34,6 +34,8 @@ If SeLinux is enabled, be sure that the Apache user can write to the directory d chcon -R -t httpd_sys_content_rw_t /var/www/html/kanboard/data ``` +You can also disable SeLinux if you don't need it. + Centos 6.5 ---------- diff --git a/docs/cli.markdown b/docs/cli.markdown index 4c4913e8b..c7cb68f6c 100644 --- a/docs/cli.markdown +++ b/docs/cli.markdown @@ -4,7 +4,7 @@ Command Line Interface Kanboard provide a simple command line interface that can be used from any Unix terminal. This tool can be used only on the local machine. -This feature is useful to run commands outside the web server by example a huge report. +This feature is useful to run commands outside the web server process by example running a huge report. Usage ----- diff --git a/docs/creating-projects.markdown b/docs/creating-projects.markdown index fe19332cb..c2c6cf3d9 100644 --- a/docs/creating-projects.markdown +++ b/docs/creating-projects.markdown @@ -3,12 +3,26 @@ Creating projects Kanboard can handle multiple projects. -To create a new project, click on the top menu "projects" and click on the link "New project". +Creating projects for multiple users +------------------------------------- -![Project creation link](http://kanboard.net/screenshots/documentation/project-creation-link.png) +- Only administrators can create and manage those projects +- User management is available +To create a new project, click on the top menu **Projects** and click on the link **New project**. Then the form appears: ![Project creation form](http://kanboard.net/screenshots/documentation/project-creation-form.png) It's very easy, you just have to find a name for your project. + +Creating a private prooject +--------------------------- + +- Everybody can create a private project +- There is **NO** user management +- Only the owner and administrators can access to the project + +To create a new private project, click on the top menu **Projects** and click on the link **New private project**. + +Note: project names must be unique. diff --git a/docs/creating-tasks.markdown b/docs/creating-tasks.markdown index d8eb9e797..45a80f042 100644 --- a/docs/creating-tasks.markdown +++ b/docs/creating-tasks.markdown @@ -22,3 +22,4 @@ Field description: - **Color**: Choose the color of the card. - **Complexity**: Used in agile project management (Scrum), the complexity or story points is a number that tells the team how hard the story is. Often, people use the fibonacci series. - **Due Date**: Overdue tasks will have a red due date and upcoming due dates will be black on the board. Several date format are accepted in addition to the date picker. +- **Original Estimate**: Estimation in hours to complete the tasks. \ No newline at end of file diff --git a/docs/email-configuration.markdown b/docs/email-configuration.markdown index 63ed97891..614fe5da2 100644 --- a/docs/email-configuration.markdown +++ b/docs/email-configuration.markdown @@ -93,14 +93,9 @@ Here a example: ### How to display a link to the task in notifications? -To do that, you have to specify the URL of your Kanboard installation in your config file. +To do that, you have to specify the URL of your Kanboard installation in your [Application Settings](http://kanboard.net/documentation/application-configuration). By default, nothing is defined, so no links will be displayed. -```php -// Your Kanboard base URL, example: http://demo.kanboard.net/ (used by email notifications or CLI scripts) -define('KANBOARD_URL', ''); -``` - Examples: - http://demo.kanboard.net/ diff --git a/docs/github-authentication.markdown b/docs/github-authentication.markdown index ef99bb80c..d6c1e1e8d 100644 --- a/docs/github-authentication.markdown +++ b/docs/github-authentication.markdown @@ -9,7 +9,9 @@ Requirements How does this work? ------------------- -The GitHub authentication in Kanboard uses the [OAuth 2.0](http://oauth.net/2/) protocol, so any user of Kanboard can be linked to a GitHub account. When that is done, they no longer need to manually login with their Kanboard account, but can simply automatically login with their GitHub account. +The GitHub authentication in Kanboard uses the [OAuth 2.0](http://oauth.net/2/) protocol, so any user of Kanboard can be linked to a GitHub account. + +When that is done, they no longer need to manually login with their Kanboard account, but can simply automatically login with their GitHub account. How to link a GitHub account ---------------------------------- @@ -26,16 +28,16 @@ Installation instructions ### Setting up OAuth 2.0 -If you know what you're doing, you can directly go to the ["Register a new OAuth application"](https://github.com/settings/applications/new) site, set everything up and skip to [Setting up Kanboard](#setting-up-kanboard) below. +On Github, go to the page ["Register a new OAuth application"](https://github.com/settings/applications/new). -Summarizing the [official GitHub documentation](https://developer.github.com/guides/basics-of-authentication/#registering-your-app): +Just follow the [official GitHub documentation](https://developer.github.com/guides/basics-of-authentication/#registering-your-app): -- Open your [**Settings**](https://github.com/settings), select [**Applications**](https://github.com/settings/applications) from the sidebar and click on [**Register new application**](https://github.com/settings/applications/new) on the top, next to where it says **Developer applications** -- Fill out the form with whatever values you like, only the **Authorization callback URL** _must_ be: **http://YOUR_SERVER/?controller=user&action=gitHub** +- Open your [Settings](https://github.com/settings), select [Applications](https://github.com/settings/applications) from the sidebar and click on [Register new application](https://github.com/settings/applications/new) on the top, next to where it says **Developer applications** +- Fill out the form with whatever values you like, the **Authorization callback URL** _must_ be: **http://YOUR_SERVER/?controller=user&action=gitHub** ### Setting up Kanboard -Either create a new `config.php` file or copy and rename the `config.default.php` file and set the following values: +Either create a new `config.php` file or rename the `config.default.php` file and set the following values: ```php // Enable/disable GitHub authentication diff --git a/docs/installation.markdown b/docs/installation.markdown index ed12dd5bd..0da0ec973 100644 --- a/docs/installation.markdown +++ b/docs/installation.markdown @@ -14,12 +14,14 @@ From the archive 1. You must have a web server with PHP installed 2. Download the source code and copy the directory `kanboard` where you want -3. Check if the directory `data` is writeable (It's the location Kanboard stores uploaded files as well as the sqlite database) +3. Check if the directory `data` is writeable 4. With your browser go to 5. The default login and password is **admin/admin** 6. Start to use the software 7. Don't forget to change your password! +Note: The folder data is the location where Kanboard stores uploaded files as well as the Sqlite database. + From the repository ------------------- diff --git a/docs/ldap-authentication.markdown b/docs/ldap-authentication.markdown index 0c4a5720f..900f31076 100644 --- a/docs/ldap-authentication.markdown +++ b/docs/ldap-authentication.markdown @@ -5,18 +5,21 @@ Requirements ------------ - LDAP extension for PHP -- LDAP server (By example: OpenLDAP or Microsoft Active Directory) +- LDAP server: + - OpenLDAP + - Microsoft Active Directory + - Novell eDirectory Workflow -------- When the LDAP authentication is activated, the login process work like that: -1. Try to authenticate the user by using the database +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. -Differences between a local user and a LDAP user are the following: +### Differences between a local user and a LDAP user are the following: - LDAP users have no local passwords - LDAP users can't modify their password with the user interface diff --git a/docs/mysql-configuration.markdown b/docs/mysql-configuration.markdown index a46dcbf85..b1934947f 100644 --- a/docs/mysql-configuration.markdown +++ b/docs/mysql-configuration.markdown @@ -4,8 +4,6 @@ How to use Mysql or MariaDB instead of Sqlite By default Kanboard use Sqlite to stores its data. However it's possible to use Mysql or MariaDB instead of Sqlite. -By example, it can be useful if you don't want to store any data on the web server itself. - Mysql configuration ------------------- @@ -37,7 +35,7 @@ The second step is to create a config file named `config.php`: ### Define Mysql parameters -Inside our config file write those lines: +Copy and paste this config file and replace the values: ```php