index.markdown

Documentation

Using Kanboard

Introduction

• What is Kanban?
• Kanban vs Todo Lists and Scrum
• Usage examples

Working with projects

• Creating projects
• Editing projects
• Sharing boards and tasks
• Automatic actions
• Project permissions
• Swimlanes
• Calendar
• Budget
• Analytics

Working with tasks

• Creating tasks
• Closing tasks
• Adding screenshots
• Task links
• Transitions
• Time tracking
• Recurring tasks
• Create tasks by email
• Subtasks

Working with users

• User management
• Notifications
• Hourly rate
• Timetable
• Two factor authentication

Settings

• Keyboard shortcuts
• Application settings
• Project settings
• Board settings
• Calendar settings
• Link settings
• Currency rate
• Config file

Integrations

• Bitbucket webhooks
• Github webhooks
• Gitlab webhooks
• Hipchat
• Jabber
• Mailgun
• Sendgrid
• Slack
• Postmark
• iCalendar subscriptions
• RSS/Atom subscriptions
• Json-RPC API
• Webhooks

More

• Advanced Search Syntax
• Command line interface
• Syntax guide
• Frequently asked questions

Technical details

Installation

• Installation instructions
• Upgrade Kanboard to a new version
• Installation on Ubuntu
• Installation on Debian
• Installation on Centos
• Installation on FreeBSD
• Installation on Windows Server with IIS
• Installation on Windows Server with Apache
• Installation on Heroku
• Example with Nginx + HTTPS + SPDY + PHP-FPM
• Run Kanboard with Docker

Configuration

• Email configuration

Database

• Sqlite database management
• How to use Mysql
• How to use Postgresql

Authentication

• LDAP authentication
• Google authentication
• GitHub authentication
• Reverse proxy authentication

Contributors

• Contributor guide
• Translations
• Coding standards
• Running tests
• Build assets
• Run Kanboard with Vagrant

The documentation is written in Markdown. If you want to improve the documentation, just send a pull-request.