Kanboard Documentation

Table of Contents

Using Kanboard

Advanced Search Syntax
Automatic Actions
Boards
iCalendar Subscriptions
Keyboard Shortcuts
Markdown Syntax
Notifications
Project Analytics
Projects
RSS/Atom Subscriptions
Settings
Subtasks
Swimlanes
Tasks
Time Tracking
Users and Groups

Contributing to Kanboard

Automated Tests
Building Javascript and CSS files
Coding Standards
Translations
Webhooks

Administration

Background Workers
Command Line Interface
Configuration File
Cronjob Configuration
Debian Installation
Docker Image Usage
Email Configuration
Frequently Asked Questions
Installation Instructions
Installation on Microsoft Windows Server
Installation on RedHat/Centos/Oracle Linux Enterprise
LDAP Configuration Parameters
MySQL/MariaDB
Performances
Plugins Installation
Postgresql
Requirements and Prerequisites
Reverse Proxy Authentication
Security
Sqlite
Ubuntu Installation
Upgrading to a New Version
URL Rewriting

Developing Plugins

Add Notification Types with Plugins
Adding Automatic Actions
Authentication Architecture
Authentication Providers
Authorization Architecture
Avatar Providers
Custom Group Providers
Custom Routes
External Link Providers
External Task Providers
LDAP Library
Mail Transport
Metadata
Plugin Hooks
Plugin Overrides
Plugin Registration
Plugin Schema Migrations
Registering new helpers
Using Events

API Reference

API Authentication
API Examples
Application API Procedures
Automatic Actions API Procedures
Board API Procedures
Category API Procedures
Column API Procedures
Comment API Procedures
External Task Link API Procedures
Group API Procedures
Group Member API Procedures
Internal Task Link API Procedures
Link API Procedures
Project API Procedures
Project File API Procedures
Project Metadata API Procedures
Project Permission API Procedures
Subtask API Procedures
Subtask Time Tracking API procedures
Swimlane API Procedures
Tags API Procedures
Task API Procedures
Task File API Procedures
Task Metadata API Procedures
User API Procedures
User API Specific Procedures

Kanboard

Kanboard is a free and open source Kanban project management software.

Official website
Bug Tracker
Discourse Forum - GitHub Discussions
RSS Feed
Mastodon - Twitter

This documentation is also available in Czech, French, Portuguese, Spanish, Russian, and Turkish.

Table of Contents

What is Kanban?
Kanboard version 1.x