Go to file

Francois Ferrand dedf425e81 Add project description field. Description is shown in a popup when hovering the 'information' icon, like column description, which is shown in project list on dashboard and in board's title. This is useful to document the categories and colors used in the project.		2015-02-24 14:21:23 +01:00
app	Add project description field.	2015-02-24 14:21:23 +01:00
assets	Add task menu in collapsed mode	2015-02-21 17:43:15 -05:00
data	First commit	2014-01-25 14:56:02 -05:00
docs	Add project description field.	2015-02-24 14:21:23 +01:00
scripts	Exclude file from the archive	2015-02-22 12:10:03 -05:00
tests	Display unfinished subtasks in the calendar	2015-02-15 21:00:04 -05:00
.gitignore	Add ignored assets from git	2015-01-30 19:27:06 -05:00
.scrutinizer.yml	Fixes for scrutinizer	2014-11-23 14:50:03 -05:00
.travis.yml	Switch to composer	2014-11-04 21:33:05 -05:00
Dockerfile	Fix Dockerfile to support Composer.	2014-12-03 14:13:01 +01:00
LICENSE	First commit	2014-01-25 14:56:02 -05:00
README.markdown	Update documentation	2015-02-21 21:05:56 -05:00
Vagrantfile	Add Debian 6 in Vagrantfile to test with PHP 5.3.3	2015-02-21 15:56:12 -05:00
app.json	Add Heroku one-click install button	2015-01-12 22:25:44 -05:00
composer.json	Refactoring/simplification of the pull-request about links	2015-02-14 16:11:13 -05:00
composer.lock	Add missing locale	2015-02-15 16:41:19 -05:00
config.default.php	Lowercase LDAP usernames by default for authentication	2015-02-20 19:42:27 -05:00
index.php	Use Pimple instead of Core\Registry and add Monolog for logging	2014-11-14 22:44:25 -05:00
jsonrpc.php	Add project description field.	2015-02-24 14:21:23 +01:00
kanboard	Add boostrap subscriber to cli script	2015-01-10 11:02:23 -05:00
robots.txt	First commit	2014-01-25 14:56:02 -05:00

README.markdown

Kanboard

Kanboard is a simple visual task board web application.

Official website: http://kanboard.net

Inspired by the Kanban methodology
Get a visual and clear overview of your project
Multiple boards with the ability to drag and drop tasks
Minimalist software, focus only on essential features (Less is more)
Open source and self-hosted
Super simple installation

Features

Multiple boards/projects
Boards customization, rename/add/remove columns
Tasks with different colors, categories, sub-tasks, attachments, comments and Markdown support for the description
Automatic actions based on events
User management with a basic privileges separation (administrator or regular user)
Email notifications
External authentication: Google, GitHub, LDAP/ActiveDirectory and Reverse-Proxy
Webhooks to create tasks from an external software
A basic command line interface
Host anywhere (shared hosting, VPS, Raspberry Pi or localhost)
No external dependencies
Super easy setup, copy and paste files and you are done!
Translated in 15 languages (Brazilian, Chinese, Danish, English, Finnish, French, German, Hungarian, Italian, Japanese, Polish, Russian, Spanish, Swedish, Thai)

Known bugs and feature requests

See Issues: https://github.com/fguillot/kanboard/issues

License

GNU Affero General Public License version 3: http://www.gnu.org/licenses/agpl-3.0.txt

Documentation

Using Kanboard

Introduction

Working with projects

Working with tasks

Working with users

User management

Settings

Integrations

Technical details

Installation

Database

Authentication

Developers and sysadmins

Contributors

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

FAQ

Go to the official website: http://kanboard.net/faq

Authors

Original author: Frédéric Guillot

Contributors:

There is also many people who have reported bugs or proposed awesome ideas.