Documentation
=============

Using Kanboard
--------------

### Introduction

- [What is Kanban?](what-is-kanban.markdown)
- [Kanban vs Todo Lists and Scrum](kanban-vs-todo-and-scrum.markdown)
- [Usage examples](usage-examples.markdown)

### Using the board

- [Board, Calendar, List and Gantt views](project-views.markdown)
- [Collapsed and expanded mode](board-collapsed-expanded.markdown)
- [Horizontal scrolling and compact mode](board-horizontal-scrolling-and-compact-view.markdown)
- [Show and hide columns](board-show-hide-columns.markdown)

### Working with projects

- [Project Types](project-types.markdown)
- [Creating projects](creating-projects.markdown)
- [Editing projects](editing-projects.markdown)
- [Sharing boards and tasks](sharing-projects.markdown)
- [Automatic actions](automatic-actions.markdown)
- [Project permissions](project-permissions.markdown)
- [Swimlanes](swimlanes.markdown)
- [Calendar](calendar.markdown)
- [Analytics](analytics.markdown)
- [Gantt chart for tasks](gantt-chart-tasks.markdown)
- [Gantt chart for projects](gantt-chart-projects.markdown)
- [Custom filters](custom-filters.markdown)

### Working with tasks

- [Creating tasks](creating-tasks.markdown)
- [Closing tasks](closing-tasks.markdown)
- [Duplicate and move tasks](duplicate-move-tasks.markdown)
- [Adding screenshots](screenshots.markdown)
- [Task links](task-links.markdown)
- [Transitions](transitions.markdown)
- [Time tracking](time-tracking.markdown)
- [Recurring tasks](recurring-tasks.markdown)
- [Create tasks by email](create-tasks-by-email.markdown)
- [Subtasks](subtasks.markdown)
- [Analytics for tasks](analytics-tasks.markdown)
- [User mentions](user-mentions.markdown)

### Working with users and groups

- [Roles](roles.markdown)
- [User Types](user-types.markdown)
- [Group management](groups.markdown)
- [User management](user-management.markdown)
- [Notifications](notifications.markdown)
- [Two factor authentication](2fa.markdown)

### Settings

- [Keyboard shortcuts](keyboard-shortcuts.markdown)
- [Application settings](application-configuration.markdown)
- [Project settings](project-configuration.markdown)
- [Board settings](board-configuration.markdown)
- [Calendar settings](calendar-configuration.markdown)
- [Link settings](link-labels.markdown)
- [Currency rate](currency-rate.markdown)

### Integrations

- [iCalendar subscriptions](ical.markdown)
- [RSS/Atom subscriptions](rss.markdown)
- [Json-RPC API](api-json-rpc.markdown)
- [Webhooks](webhooks.markdown)
- [Plugins](plugins.markdown)

### More

- [Advanced Search Syntax](search.markdown)
- [Command line interface](cli.markdown)
- [Syntax guide](syntax-guide.markdown)
- [Brute force protection](bruteforce-protection.markdown)
- [Frequently asked questions](faq.markdown)

Technical details
-----------------

### Installation

- [Requirements](requirements.markdown)
- [Installation instructions](installation.markdown)
- [Upgrade Kanboard to a new version](update.markdown)
- [Installation on Ubuntu](ubuntu-installation.markdown)
- [Installation on Debian](debian-installation.markdown)
- [Installation on Centos](centos-installation.markdown)
- [Installation on FreeBSD](freebsd-installation.markdown)
- [Installation on Windows Server with IIS](windows-iis-installation.markdown)
- [Installation on Windows Server with Apache](windows-apache-installation.markdown)
- [Installation on Heroku](heroku.markdown)
- [Run Kanboard with Docker](docker.markdown)
- [Run Kanboard with Vagrant](vagrant.markdown)

### Configuration

- [Config file](config.markdown)
- [Email configuration](email-configuration.markdown)
- [URL rewriting](nice-urls.markdown)

### Database

- [Sqlite database management](sqlite-database.markdown)
- [How to use Mysql](mysql-configuration.markdown)
- [How to use Postgresql](postgresql-configuration.markdown)

### Authentication

- [LDAP authentication](ldap-authentication.markdown)
- [LDAP group synchronization](ldap-group-sync.markdown)
- [LDAP parameters](ldap-parameters.markdown)
- [Google authentication](google-authentication.markdown)
- [Github authentication](github-authentication.markdown)
- [Gitlab authentication](gitlab-authentication.markdown)
- [Reverse proxy authentication](reverse-proxy-authentication.markdown)

### Contributors

- [Contributor guide](contributing.markdown)
- [Translations](translations.markdown)
- [Coding standards](coding-standards.markdown)
- [Running tests](tests.markdown)
- [Build assets](assets.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.