Kanboard

https://docs.kanboard.org/
Admin
Kanboard is a free and open source Kanban project management software that helps teams visualize...
Tokens:124,109
Snippets:1,064
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install a Plugin from a URL

Source: https://docs.kanboard.org/v1/admin/cli

Installs a Kanboard plugin from a given URL. Ensure the URL points to a valid plugin release archive. Installed files inherit permissions from the current user.

```bash
./cli plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip

```

--------------------------------

### Test Kanboard with PHP's Built-in Web Server

Source: https://docs.kanboard.org/v1/admin/faq

Provides commands to unzip Kanboard, navigate to its directory, start PHP's built-in web server on localhost:8000, and open it in a browser. Useful for local testing without a full web server installation.

```bash
unzip kanboard-VERSION.zip
cd kanboard
php -S localhost:8000
open http://localhost:8000/

```

--------------------------------

### Install Apache and PHP on Debian

Source: https://docs.kanboard.org/v1/admin/debian

Installs Apache web server and essential PHP modules required for Kanboard. Ensures Apache starts on boot.

```bash
apt update
apt install -y apache2 libapache2-mod-php php-cli php-mbstring \
    php-sqlite3 php-opcache php-json php-ldap php-gd php-xml \
    php-mysql php-pgsql php-curl php-zip

systemctl enable apache2

```

--------------------------------

### Install Apache as a Windows Service

Source: https://docs.kanboard.org/v1/admin/windows

Navigate to the Apache bin directory and use this command to install Apache as a Windows service.

```bash
cd C:\Apache24\bin

# Install the Windows service
httpd.exe -k install

```

--------------------------------

### Nginx Configuration for Kanboard in Subfolder

Source: https://docs.kanboard.org/v1/admin/url-rewriting

An advanced Nginx configuration example for Kanboard installed in a subfolder, handling SSL and specific location rules. Ensure 'PATH_INFO' and 'HTTPS' parameters are correctly set.

```nginx
server {
    listen 443 ssl default_server;
    listen [::]:443 ssl default_server;

    root /var/www/html;
    index index.php index.html index.htm;
    server_name _;

    location / {
        try_files $uri $uri/ =404;
    }

    location ^~ /kanboard {

        location /kanboard {
            try_files $uri $uri/ /kanboard/index.php$is_args$args;
        }

        location ~ ^/kanboard/(?:kanboard|config.php|config.default.php) {
            deny all;
        }

        location ~* /kanboard/data {
            deny all;
        }

        location ~ \.php(?:$|/) {
            fastcgi_split_path_info ^(.+\.php)(/.+);
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            fastcgi_param PATH_INFO $fastcgi_path_info;
            fastcgi_param HTTPS on; # Use only if HTTPS is configured
            include fastcgi_params;
            fastcgi_pass unix:/var/run/php5-fpm.sock;
        }

        location ~ /kanboard/\.ht {
            deny all;
        }
    }
}

```

--------------------------------

### Provider Registration Example

Source: https://docs.kanboard.org/v1/plugins/external_tasks

Example of how to register an external task provider in a Kanboard plugin.

```php
<?php

namespace Kanboard\Plugin\MyPlugin;

use Kanboard\Core\Base;

class Plugin extends Base
{
    public function initialize()
    {
        // Register the external task provider
        $this->externalTaskManager->register(new MyExternalTaskProvider());
    }
}

```

--------------------------------

### Plugin Registration File Example

Source: https://docs.kanboard.org/v1/plugins/registration

Provides an example of the `Plugin.php` file, which is required for registering a plugin with Kanboard. It includes the necessary namespace, class extension, and the `initialize` method.

```php
<?php

namespace Kanboard\Plugin\Foobar;

use Kanboard\Core\Plugin\Base;

class Plugin extends Base
{
    public function initialize()
    {
        $this->template->hook->attach('template:layout:head', 'theme:layout/head');
    }

    public function getCompatibleVersion()
    {
        // Examples:
        // >=1.0.37
        // <1.0.37
        // <=1.0.37
        return '1.0.37';
    }
}

```

--------------------------------

### Request Example for getMyProjects

Source: https://docs.kanboard.org/v1/api/me_procedures

This is an example of a JSON-RPC request to the getMyProjects method.

```json
{
    "jsonrpc": "2.0",
    "method": "getMyProjects",
    "id": 2134420212
}

```

--------------------------------

### Response Example for getMyProjects

Source: https://docs.kanboard.org/v1/api/me_procedures

This is an example of a successful JSON-RPC response from the getMyProjects method, listing project details.

```json
{
    "jsonrpc": "2.0",
    "id": 2134420212,
    "result": [
        {
            "id": "1",
            "name": "API test",
            "is_active": "1",
            "token": "",
            "last_modified": "1436119570",
            "is_public": "0",
            "is_private": "0",
            "default_swimlane": "Default swimlane",
            "show_default_swimlane": "1",
            "description": null,
            "identifier": "",
            "url": {
                "board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
                "calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
                "list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
            }
        }
    ]
}

```

--------------------------------

### Install Cookiecutter

Source: https://docs.kanboard.org/v1/plugins/registration

Install the cookiecutter tool, which is used for generating the project skeleton for a Kanboard plugin.

```bash
pip install -U cookiecutter

```

--------------------------------

### Install PHP and Apache Packages

Source: https://docs.kanboard.org/v1/admin/rhel

Installs essential packages for running Kanboard, including PHP with common extensions and Apache web server.

```bash
yum install -y php php-xml php-mbstring php-pdo php-gd unzip wget

```

--------------------------------

### Get All Tasks Response

Source: https://docs.kanboard.org/v1/api/task_procedures

This is an example of a successful response when fetching all tasks. It returns a list of task objects, each containing detailed information.

```json
{
    "jsonrpc": "2.0",
    "id": 133280317,
    "result": [
        {
            "id": "1",
            "title": "Task #1",
            "description": "",
            "date_creation": "1409961789",
            "color_id": "blue",
            "project_id": "1",
            "column_id": "2",
            "owner_id": "1",
            "position": "1",
            "is_active": "1",
            "date_completed": null,
            "score": "0",
            "date_due": "0",
            "category_id": "0",
            "creator_id": "0",
            "date_modification": "1409961789",
            "reference": "",
            "date_started": null,
            "time_spent": "0",
            "time_estimated": "0",
            "swimlane_id": "0",
            "date_moved": "1430783191",
            "recurrence_status": "0",
            "recurrence_trigger": "0",
            "recurrence_factor": "0",
            "recurrence_timeframe": "0",
            "recurrence_basedate": "0",
            "recurrence_parent": null,
            "recurrence_child": null,
            "priority": "0",
            "external_provider": null,
            "external_uri": null,
            "url": "http:\/\/127.0.0.1:8000\/?controller=task&action=show&task_id=1&project_id=1",
            "color": {
                "name": "Blue",
                "background": "rgb(219, 235, 255)",
                "border": "rgb(168, 207, 255)"
            }
        },
        {
            "id": "2",
            "title": "Test",
            "description": "",
            "date_creation": "1409962115",
            "color_id": "green",
            "project_id": "1",
            "column_id": "2",
            "owner_id": "1",
            "position": "2",
            "is_active": "1",
            "date_completed": null,
            "score": "0",
            "date_due": "0",
            "category_id": "0",
            "creator_id": "0",
            "date_modification": "1409962115",
            "reference": "",
            "date_started": null,
            "time_spent": "0",
            "time_estimated": "0",
            "swimlane_id": "0",
            "date_moved": "1430783191",
            "recurrence_status": "0",
            "recurrence_trigger": "0",
            "recurrence_factor": "0",
            "recurrence_timeframe": "0",
            "recurrence_basedate": "0",
            "recurrence_parent": null,
            "recurrence_child": null,
            "priority": "0",
            "external_provider": null,
            "external_uri": null,
            "url": "http:\/\/127.0.0.1:8000\/?controller=task&action=show&task_id=2&project_id=1",
            "color": {
                "name": "Green",
                "background": "rgb(189, 244, 203)",
                "border": "rgb(74, 227, 113)"
            }
        }
    ]
}

```

--------------------------------

### Install Kanboard on Ubuntu 20.04

Source: https://docs.kanboard.org/v1/admin/ubuntu

Downloads, extracts, and sets permissions for the Kanboard application.

```bash
# Adapt version number
version=1.2.24

# Download the latest release from https://github.com/kanboard/kanboard/releases
wget https://github.com/kanboard/kanboard/archive/v$version.tar.gz
tar xzvf v$version.tar.gz -C /var/www/html/
chown -R www-data:www-data /var/www/html/kanboard-$version/data

rm v$version.tar.gz
```

--------------------------------

### Install Apache and PHP on Ubuntu 20.04

Source: https://docs.kanboard.org/v1/admin/ubuntu

Installs the Apache web server and required PHP extensions for Ubuntu Focal Fossa.

```bash
sudo apt update
sudo apt install -y apache2 libapache2-mod-php php-cli php-mbstring php-sqlite3 php-opcache php-json php-mysql php-pgsql php-ldap php-gd php-xml
```

--------------------------------

### Install Nginx and PHP on Ubuntu 20.04

Source: https://docs.kanboard.org/v1/admin/ubuntu

Installs the Nginx web server and required PHP-FPM extensions for Ubuntu Focal Fossa.

```bash
sudo apt update
sudo apt install nginx php-fpm php-mysql php-pgsql php-gd php-mbstring php-sqlite3 php-xml
```

--------------------------------

### Kanboard API getTask Response Example

Source: https://docs.kanboard.org/v1/api/task_procedures

This is an example JSON-RPC response for a successful 'getTask' request, showing the properties of the retrieved task.

```json
{
    "jsonrpc": "2.0",
    "id": 700738119,
    "result": {
        "id": "1",
        "title": "Task #1",
        "description": "",
        "date_creation": "1409963206",
        "color_id": "blue",
        "project_id": "1",
        "column_id": "2",
        "owner_id": "1",
        "position": "1",
        "is_active": "1",
        "date_completed": null,
        "score": "0",
        "date_due": "0",
        "category_id": "0",
        "creator_id": "0",
        "date_modification": "1409963206",
        "reference": "",
        "date_started": null,
        "time_spent": "0",
        "time_estimated": "0",
        "swimlane_id": "0",
        "date_moved": "1430875287",
        "recurrence_status": "0",
        "recurrence_trigger": "0",
        "recurrence_factor": "0",
        "recurrence_timeframe": "0",
        "recurrence_basedate": "0",
        "recurrence_parent": null,
        "recurrence_child": null,
        "url": "http:\/\/127.0.0.1:8000\/?controller=task&action=show&task_id=1&project_id=1",
        "color": {
            "name": "Yellow",
            "background": "rgb(245, 247, 196)",
            "border": "rgb(223, 227, 45)"
        }
    }
}

```

--------------------------------

### Symlinks for Installation Outside Document Root

Source: https://docs.kanboard.org/v1/admin/security

When installing Kanboard outside the web server's document root, create these symlinks to make Kanboard accessible.

```text
.
├── assets -> ../kanboard/assets
├── cli -> ../kanboard/cli
├── favicon.ico -> ../kanboard/favicon.ico
├── index.php -> ../kanboard/index.php
├── jsonrpc.php -> ../kanboard/jsonrpc.php
└── robots.txt -> ../kanboard/robots.txt


```

--------------------------------

### Example HTTP Request for Webhook

Source: https://docs.kanboard.org/v1/dev/webhooks

This example demonstrates the structure of an HTTP POST request sent by Kanboard when a task is moved between columns. It includes the webhook URL, token, headers, and a JSON payload detailing the event and task changes. Ensure your receiver responds within 1 second.

```http
POST https://your_webhook_url/?token=WEBHOOK_TOKEN_HERE
User-Agent: Kanboard Webhook
Content-Type: application/json
Connection: close

{
    "event_name": "task.move.column",
    "event_data": {
        "task_id": "4",
        "task": {
            "id": "4",
            "reference": "",
            "title": "My task",
            "description": "",
            "date_creation": "1469314356",
            "date_completed": null,
            "date_modification": "1469315422",
            "date_due": "1469491200",
            "date_started": "0",
            "time_estimated": "0",
            "time_spent": "0",
            "color_id": "green",
            "project_id": "1",
            "column_id": "1",
            "owner_id": "1",
            "creator_id": "1",
            "position": "1",
            "is_active": "1",
            "score": "0",
            "category_id": "0",
            "priority": "0",
            "swimlane_id": "0",
            "date_moved": "1469315422",
            "recurrence_status": "0",
            "recurrence_trigger": "0",
            "recurrence_factor": "0",
            "recurrence_timeframe": "0",
            "recurrence_basedate": "0",
            "recurrence_parent": null,
            "recurrence_child": null,
            "category_name": null,
            "swimlane_name": null,
            "project_name": "Demo Project",
            "default_swimlane": "Default swimlane",
            "column_title": "Backlog",
            "assignee_username": "admin",
            "assignee_name": null,
            "creator_username": "admin",
            "creator_name": null
        },
        "changes": {
            "src_column_id": "2",
            "dst_column_id": "1",
            "date_moved": "1469315398"
        },
        "project_id": "1",
        "position": 1,
        "column_id": "1",
        "swimlane_id": "0",
        "src_column_id": "2",
        "dst_column_id": "1",
        "date_moved": "1469315398",
        "recurrence_status": "0",
        "recurrence_trigger": "0"
    }
}
```

--------------------------------

### Install Apache and PHP on Ubuntu 18.04

Source: https://docs.kanboard.org/v1/admin/ubuntu

Installs the Apache web server and specific PHP 7.2 extensions for Ubuntu Bionic Beaver.

```bash
sudo apt-get update
sudo apt-get install -y apache2 libapache2-mod-php7.2 php7.2-cli php7.2-mbstring php7.2-sqlite3 \
    php7.2-opcache php7.2-json php7.2-mysql php7.2-pgsql php7.2-ldap php7.2-gd php7.2-xml
```

--------------------------------

### Configure Plugin Settings

Source: https://docs.kanboard.org/v1/admin/config

Defines the plugin directory, installer status, and API URL.

```php
define('PLUGINS_DIR', 'data/plugins');
```

```php
define('PLUGIN_INSTALLER', false); // Default is false since Kanboard v1.2.8
```

```php
define('PLUGIN_API_URL', 'https://kanboard.org/plugins.json');
```

--------------------------------

### Example Sqlite Schema Migration

Source: https://docs.kanboard.org/v1/plugins/schema_migrations

This example demonstrates a basic schema migration for Sqlite. The VERSION constant defines the latest schema version, and each function (e.g., version_1) represents a single migration step. A PDO instance is passed to each migration function, and all migrations run within a transaction.

```php
<?php

namespace Kanboard\Plugin\Something\Schema;

const VERSION = 1;

function version_1($pdo)
{
    $pdo->exec('CREATE TABLE IF NOT EXISTS something (
        "id" INTEGER PRIMARY KEY,
        "project_id" INTEGER NOT NULL,
        "something" TEXT,
        FOREIGN KEY(project_id) REFERENCES projects(id) ON DELETE CASCADE
    )');
}

```

--------------------------------

### Response getProjectRoles

Source: https://docs.kanboard.org/v1/api/application_procedures

Example JSON-RPC response containing the mapping of roles.

```json
{
    "jsonrpc": "2.0",
    "id": 8981960,
    "result": {
        "project-manager": "Project Manager",
        "project-member": "Project Member",
        "project-viewer": "Project Viewer"
    }
}
```

--------------------------------

### Open Task Response Example

Source: https://docs.kanboard.org/v1/api/task_procedures

This is a successful response for the 'openTask' method, confirming the task has been opened.

```json
{
    "jsonrpc": "2.0",
    "id": 1888531925,
    "result": true
}

```

--------------------------------

### Run Kanboard with Plugins Enabled

Source: https://docs.kanboard.org/v1/admin/docker

Starts the container with the PLUGIN_INSTALLER environment variable set to true to allow web-based plugin management.

```bash
docker run --rm \
  --name=kanboard \
  -p 8080:80 \
  -e PLUGIN_INSTALLER=true \
  kanboard/kanboard:latest
```

--------------------------------

### Get project by name

Source: https://docs.kanboard.org/v1/api/project_procedures

Retrieves project properties by searching for the project name.

```json
{
    "jsonrpc": "2.0",
    "method": "getProjectByName",
    "id": 1620253806,
    "params": {
        "name": "Test"
    }
}
```

```json
{
    "jsonrpc": "2.0",
    "id": 1620253806,
    "result": {
        "id": "1",
        "name": "Test",
        "is_active": "1",
        "token": "",
        "last_modified": "1436119135",
        "is_public": "0",
        "is_private": "0",
        "default_swimlane": "Default swimlane",
        "show_default_swimlane": "1",
        "description": "test",
        "identifier": "",
        "url": {
            "board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
            "calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
            "list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
        }
    }
}
```

--------------------------------

### Configure SMTP Encryption

Source: https://docs.kanboard.org/v1/admin/email

Examples for setting up common SMTP encryption ports and protocols.

```php
define('MAIL_SMTP_PORT', 465);
define('MAIL_SMTP_ENCRYPTION', 'ssl');
```

```php
define('MAIL_SMTP_PORT', 587);
define('MAIL_SMTP_ENCRYPTION', 'tls');
```

--------------------------------

### Get User Dashboard Response

Source: https://docs.kanboard.org/v1/api/me_procedures

This is an example of a successful response when requesting the user's dashboard. It includes project and task information.

```json
{
    "jsonrpc": "2.0",
    "id": 1563664593,
    "result": {
        "projects": [
            {
                "id": "2",
                "name": "my project",
                "is_active": "1",
                "token": "",
                "last_modified": "1438205337",
                "is_public": "0",
                "is_private": "1",
                "default_swimlane": "Default swimlane",
                "show_default_swimlane": "1",
                "description": null,
                "identifier": "",
                "columns": [
                    {
                        "id": "5",
                        "title": "Backlog",
                        "position": "1",
                        "project_id": "2",
                        "task_limit": "0",
                        "description": "",
                        "nb_tasks": 0
                    },
                    {
                        "id": "6",
                        "title": "Ready",
                        "position": "2",
                        "project_id": "2",
                        "task_limit": "0",
                        "description": "",
                        "nb_tasks": 0
                    },
                    {
                        "id": "7",
                        "title": "Work in progress",
                        "position": "3",
                        "project_id": "2",
                        "task_limit": "0",
                        "description": "",
                        "nb_tasks": 0
                    },
                    {
                        "id": "8",
                        "title": "Done",
                        "position": "4",
                        "project_id": "2",
                        "task_limit": "0",
                        "description": "",
                        "nb_tasks": 0
                    }
                ],
                "url": {
                    "board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=2",
                    "calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=2",
                    "list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=2"
                }
            }
        ],
        "tasks": [
            {
                "id": "1",
                "title": "new title",
                "date_due": "0",
                "date_creation": "1438205336",
                "project_id": "2",
                "color_id": "yellow",
                "time_spent": "0",
                "time_estimated": "0",
                "project_name": "my project",
                "url": "http:\/\/127.0.0.1:8000\/?controller=task&action=show&task_id=1&project_id=2"
            }
        ],
        "subtasks": []
    }
}

```

--------------------------------

### Example Plugin Directory Structure

Source: https://docs.kanboard.org/v1/plugins/registration

Illustrates the typical directory structure for a Kanboard plugin, highlighting essential files and optional folders.

```text
plugins
└── Budget            <= Plugin name
    ├── Asset         <= JavaScript/CSS files
    ├── Controller
    ├── LICENSE       <= Plugin license
    ├── Locale
    │   ├── fr_FR
    │   ├── it_IT
    │   ├── ja_JP
    │   └── zh_CN
    ├── Model
    ├── Plugin.php    <= Plugin registration file
    ├── README.md
    ├── Schema        <= Database migrations
    ├── Template
    └── Test          <= Unit tests

```

--------------------------------

### Get Current User Session Response

Source: https://docs.kanboard.org/v1/api/me_procedures

This is an example of a successful response when requesting the current user's session data. It includes user details and settings.

```json
{
    "jsonrpc": "2.0",
    "id": 1718627783,
    "result": {
        "id": 2,
        "username": "user",
        "role": "app-user",
        "is_ldap_user": false,
        "name": "",
        "email": "",
        "google_id": null,
        "github_id": null,
        "notifications_enabled": "0",
        "timezone": null,
        "language": null,
        "disable_login_form": "0",
        "twofactor_activated": false,
        "twofactor_secret": null,
        "token": "",
        "notifications_filter": "4"
    }
}

```

--------------------------------

### Import SQL Dump for Database Initialization

Source: https://docs.kanboard.org/v1/admin/mysql

Initialize the Kanboard database schema by importing the provided SQL dump. This is an alternative to letting Kanboard run migrations on first use, which can help avoid timeouts.

```bash
mysql -u root -p kanboard < app/Schema/Sql/mysql.sql

```

--------------------------------

### Download and Install Kanboard

Source: https://docs.kanboard.org/v1/admin/rhel

Downloads the latest Kanboard release, extracts it to the web server's document root, and sets correct ownership for the data directory.

```bash
cd /var/www/html

# Download the latest release from https://github.com/kanboard/kanboard/releases
wget https://github.com/kanboard/kanboard/archive/v<version>.zip

unzip kanboard-<version>.zip
chown -R apache:apache kanboard-<version>/data
rm kanboard-<version>.zip

```

--------------------------------

### Start Kanboard with Docker Compose

Source: https://docs.kanboard.org/v1/admin/docker

Command to initiate the Kanboard containers defined in your Docker Compose file.

```bash
docker compose up

```

--------------------------------

### Install Kanboard on Ubuntu 18.04

Source: https://docs.kanboard.org/v1/admin/ubuntu

Downloads, extracts, and sets permissions for the Kanboard application using ZIP archives.

```bash
cd /var/www/html

# Download the latest release from https://github.com/kanboard/kanboard/releases
wget https://github.com/kanboard/kanboard/archive/v<version>.zip

unzip kanboard-<version>.zip
chown -R www-data:www-data kanboard-<version>/data
rm kanboard-<version>.zip
```

--------------------------------

### Kanboard API getTask Request Example

Source: https://docs.kanboard.org/v1/api/task_procedures

This is an example JSON-RPC request to retrieve a specific task by its ID.

```json
{
    "jsonrpc": "2.0",
    "method": "getTask",
    "id": 700738119,
    "params": {
        "task_id": 1
    }
}

```

--------------------------------

### Download and Install Kanboard

Source: https://docs.kanboard.org/v1/admin/debian

Downloads the specified version of Kanboard, extracts it to the web server's document root, sets ownership for the data directory, and cleans up the downloaded archive.

```bash
version=1.2.13
wget https://github.com/kanboard/kanboard/archive/v$version.tar.gz
tar xzvf v$version.tar.gz -C /var/www/html/
chown -R www-data:www-data /var/www/html/kanboard-$version/data

rm v$version.tar.gz

```

--------------------------------

### Kanboard CLI Help Output

Source: https://docs.kanboard.org/v1/admin/cli

Displays all available commands and options for the Kanboard CLI. Use this to understand the full range of functionalities.

```bash
Kanboard v1.2.11

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output, and 3 for debug

Available commands:
  cronjob                            Execute daily cronjob
  css                                Minify CSS files
  help                               Displays help for a command
  job                                Execute individual job (read payload from stdin)
  js                                 Minify JavaScript files
  list                               Lists commands
  version                            Display Kanboard version
  worker                             Execute queue worker
 db
  db:migrate                         Execute SQL migrations
  db:version                         Show database schema version
 export
  export:daily-project-column-stats  Daily project column stats CSV export (number of tasks per column and per day)
  export:subtasks                    Subtasks CSV export
  export:tasks                       Tasks CSV export
  export:transitions                 Task transitions CSV export
 locale
  locale:compare                     Compare application translations with the fr_FR locale
  locale:sync                        Synchronize all translations based on the fr_FR locale
 notification
  notification:overdue-tasks         Send notifications for overdue tasks
 plugin
  plugin:install                     Install a plugin from a remote Zip archive
  plugin:uninstall                   Remove a plugin
  plugin:upgrade                     Update all installed plugins
 projects
  projects:archive                   Disable projects not touched during one year
  projects:archive-activities        Remove project activities after one year
  projects:daily-stats               Calculate daily statistics for all projects
 trigger
  trigger:tasks                      Trigger scheduler event for all tasks
 user
  user:reset-2fa                     Remove two-factor authentication for a user
  user:reset-password                Change user password

```

--------------------------------

### GET /api/projects?name={name} - Get Project By Name

Source: https://docs.kanboard.org/v1/api/project_procedures

Retrieves project information using the project's name.

```APIDOC
## GET /api/projects?name={name}

### Description
Retrieves project information using the project's name.

### Method
GET

### Endpoint
/api/projects

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the project to retrieve.

### Response
#### Success Response (200)
- **project properties** (object) - An object containing all properties of the project.

#### Response Example
```json
{
    "jsonrpc": "2.0",
    "id": 1620253806,
    "result": {
        "id": "1",
        "name": "Test",
        "is_active": "1",
        "token": "",
        "last_modified": "1436119135",
        "is_public": "0",
        "is_private": "0",
        "default_swimlane": "Default swimlane",
        "show_default_swimlane": "1",
        "description": "test",
        "identifier": "",
        "url": {
            "board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
            "calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
            "list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
        }
    }
}
```
```

--------------------------------

### GET /api/projects/{project_id} - Get Project By ID

Source: https://docs.kanboard.org/v1/api/project_procedures

Retrieves detailed information about a specific project using its unique ID.

```APIDOC
## GET /api/projects/{project_id}

### Description
Retrieves detailed information about a specific project using its unique ID.

### Method
GET

### Endpoint
/api/projects/{project_id}

### Parameters
#### Path Parameters
- **project_id** (integer) - Required - The unique identifier of the project.

### Response
#### Success Response (200)
- **project properties** (object) - An object containing all properties of the project.

#### Response Example
```json
{
    "jsonrpc": "2.0",
    "id": 226760253,
    "result": {
        "id": "1",
        "name": "API test",
        "is_active": "1",
        "token": "",
        "last_modified": "1436119135",
        "is_public": "0",
        "is_private": "0",
        "default_swimlane": "Default swimlane",
        "show_default_swimlane": "1",
        "description": "test",
        "identifier": "",
        "url": {
            "board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
            "calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
            "list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
        }
    }
}
```
```

--------------------------------

### Run Kanboard Container

Source: https://docs.kanboard.org/v1/admin/docker

Basic command to start a Kanboard container instance mapping port 80.

```bash
docker run -d --name kanboard -p 80:80 -t kanboard/kanboard:v1.2.45
```

--------------------------------

### Get User Dashboard Request

Source: https://docs.kanboard.org/v1/api/me_procedures

Send this JSON-RPC request to get the dashboard of the logged-in user without pagination. No parameters are required.

```json
{
    "jsonrpc": "2.0",
    "method": "getMyDashboard",
    "id": 447898718
}

```

--------------------------------

### Create Kanboard Batch File on Windows

Source: https://docs.kanboard.org/v1/admin/cronjob

Example batch file to run the Kanboard CLI cronjob script on Windows. Adjust PHP and Kanboard paths as necessary.

```batch
"C:\php\php.exe" -f "C:\inetpub\wwwroot\kanboard\cli" cronjob
```

--------------------------------

### GET /api/projects?identifier={identifier} - Get Project By Identifier

Source: https://docs.kanboard.org/v1/api/project_procedures

Retrieves project information using the project's unique identifier.

```APIDOC
## GET /api/projects?identifier={identifier}

### Description
Retrieves project information using the project's unique identifier.

### Method
GET

### Endpoint
/api/projects

### Parameters
#### Query Parameters
- **identifier** (alphanumeric string) - Required - The unique identifier of the project.

### Response
#### Success Response (200)
- **project properties** (object) - An object containing all properties of the project.

#### Response Example
```json
{
    "jsonrpc": "2.0",
    "id": 1620253806,
    "result": {
        "id": "1",
        "name": "Test",
        "is_active": "1",
        "token": "",
        "last_modified": "1436119135",
        "is_public": "0",
        "is_private": "0",
        "default_swimlane": "Default swimlane",
        "show_default_swimlane": "1",
        "description": "test",
        "identifier": "TEST",
        "url": {
            "board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
            "calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
            "list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
        }
    }
}
```
```

--------------------------------

### LDAP User LDIF Example

Source: https://docs.kanboard.org/v1/admin/ldap

Example LDIF entry for a user in an LDAP directory. This defines the user's attributes and object classes.

```ldif
dn: uid=manager,ou=Users,dc=kanboard,dc=local
objectClass: top
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
uid: manager
sn: Lastname
givenName: Firstname
cn: Kanboard Manager
displayName: Kanboard Manager
mail: manager@kanboard.local
userPassword: password


```

--------------------------------

### Install Nginx and PHP on Ubuntu 18.04

Source: https://docs.kanboard.org/v1/admin/ubuntu

Installs the Nginx web server and specific PHP 7.2-FPM extensions for Ubuntu Bionic Beaver.

```bash
sudo apt-get update
sudo apt-get install nginx php7.2-fpm php7.2-mysql php7.2-pgsql php7.2-gd php7.2-mbstring php7.2-sqlite3 \
    php7.2-xml
```

--------------------------------

### Kanboard CLI Usage

Source: https://docs.kanboard.org/v1/admin/cli

General usage instructions for the Kanboard CLI. Navigate to the Kanboard directory and execute the `cli` script.

```APIDOC
## Kanboard CLI Usage

Kanboard provides a simple command-line interface that can be used from any Unix terminal. This tool can only be used on the local machine.
This feature is useful for running commands outside of the web server processes.

### Usage
  * Open a terminal and navigate to your Kanboard directory (e.g., `cd /var/www/kanboard`).
  * Run the command `./cli` or `php cli`.

### Available Commands
  * `cronjob`: Execute daily cronjob
  * `css`: Minify CSS files
  * `help`: Displays help for a command
  * `job`: Execute individual job (read payload from stdin)
  * `js`: Minify JavaScript files
  * `list`: Lists commands
  * `version`: Display Kanboard version
  * `worker`: Execute queue worker
  * `db:migrate`: Execute SQL migrations
  * `db:version`: Show database schema version
  * `export:daily-project-column-stats`: Daily project column stats CSV export (number of tasks per column and per day)
  * `export:subtasks`: Subtasks CSV export
  * `export:tasks`: Tasks CSV export
  * `export:transitions`: Task transitions CSV export
  * `locale:compare`: Compare application translations with the fr_FR locale
  * `locale:sync`: Synchronize all translations based on the fr_FR locale
  * `notification:overdue-tasks`: Send notifications for overdue tasks
  * `plugin:install`: Install a plugin from a remote Zip archive
  * `plugin:uninstall`: Remove a plugin
  * `plugin:upgrade`: Update all installed plugins
  * `projects:archive`: Disable projects not touched during one year
  * `projects:archive-activities`: Remove project activities after one year
  * `projects:daily-stats`: Calculate daily statistics for all projects
  * `trigger:tasks`: Trigger scheduler event for all tasks
  * `user:reset-2fa`: Remove two-factor authentication for a user
  * `user:reset-password`: Change user password

### Options
  * `-h, --help`: Display this help message
  * `-q, --quiet`: Do not output any message
  * `-V, --version`: Display this application version
  * `--ansi`: Force ANSI output
  * `--no-ansi`: Disable ANSI output
  * `-n, --no-interaction`: Do not ask any interactive question
  * `-v|vv|vvv, --verbose`: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output, and 3 for debug
```

--------------------------------

### Create PostgreSQL Database

Source: https://docs.kanboard.org/v1/admin/postgresql

Creates an empty database named 'kanboard' using the psql command-line tool. This is the first step in setting up PostgreSQL for Kanboard.

```sql
CREATE DATABASE kanboard;
```

--------------------------------

### Create Task Request Example

Source: https://docs.kanboard.org/v1/api/task_procedures

This JSON-RPC request demonstrates how to create a new task with various parameters. Ensure all required fields like title and project_id are provided.

```json
{
    "jsonrpc": "2.0",
    "method": "createTask",
    "id": 1176509098,
    "params": {
        "owner_id": 1,
        "creator_id": 0,
        "date_due": "",
        "description": "",
        "category_id": 0,
        "score": 0,
        "title": "Test",
        "project_id": 1,
        "color_id": "green",
        "column_id": 2,
        "recurrence_status": 0,
        "recurrence_trigger": 0,
        "recurrence_factor": 0,
        "recurrence_timeframe": 0,
        "recurrence_basedate": 0
    }
}
```

--------------------------------

### Request Example for getMyActivityStream

Source: https://docs.kanboard.org/v1/api/me_procedures

This is an example of the JSON-RPC request payload to call the getMyActivityStream method. It specifies the method to be invoked and includes a unique identifier for the request.

```json
{
    "jsonrpc": "2.0",
    "method": "getMyActivityStream",
    "id": 1132562181
}

```

--------------------------------

### Configure IIS web.config for URL Rewriting

Source: https://docs.kanboard.org/v1/admin/url-rewriting

Create this file in the installation folder to enable URL rewriting. Requires the IIS Rewrite module to be installed.

```xml
<?xml version="1.0"?>
<configuration>
    <system.webServer>
        <defaultDocument>
            <files>
                <clear />
                <add value="index.php" />
            </files>
        </defaultDocument>
        <rewrite>
            <rules>
                <rule name="Kanboard URL Rewrite" stopProcessing="true">
                    <match url="^(.*)$" ignoreCase="false" />
                    <conditions logicalGrouping="MatchAll">
                        <add input="{REQUEST_FILENAME}" matchType="IsFile" ignoreCase="false" negate="true" />
                    </conditions>
                    <action type="Rewrite" url="index.php" appendQueryString="true" />
                </rule>
            </rules>
        </rewrite>
    </system.webServer>
</configuration>
```

--------------------------------

### Integrate with Kanboard using Python

Source: https://docs.kanboard.org/v1/api/examples

Installation and usage of the official Kanboard Python client to manage projects and tasks.

```bash
pip install kanboard
```

```python
import kanboard

kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')

project_id = kb.create_project(name='My project')
kb.add_project_user(project_id=project_id, user_id=123, role='project-manager')

task_id = kb.create_task(project_id=project_id, title='My task title')
print(f"Created task with ID: {task_id}")
```

--------------------------------

### Response Example for getMyActivityStream

Source: https://docs.kanboard.org/v1/api/me_procedures

This is an example of a successful JSON-RPC response from the getMyActivityStream method. It contains a list of recent user events, including details about task creation and modifications.

```json
{
    "jsonrpc": "2.0",
    "id": 1132562181,
    "result": [
        {
            "id": "1",
            "date_creation": "1438205054",
            "event_name": "task.create",
            "creator_id": "2",
            "project_id": "2",
            "task_id": "1",
            "author_username": "user",
            "author_name": "",
            "email": "",
            "task": {
                "id": "1",
                "reference": "",
                "title": "my user title",
                "description": "",
                "date_creation": "1438205054",
                "date_completed": null,
                "date_modification": "1438205054",
                "date_due": "0",
                "date_started": null,
                "time_estimated": "0",
                "time_spent": "0",
                "color_id": "yellow",
                "project_id": "2",
                "column_id": "5",
                "owner_id": "0",
                "creator_id": "2",
                "position": "1",
                "is_active": "1",
                "score": "0",
                "category_id": "0",
                "swimlane_id": "0",
                "date_moved": "1438205054",
                "recurrence_status": "0",
                "recurrence_trigger": "0",
                "recurrence_factor": "0",
                "recurrence_timeframe": "0",
                "recurrence_basedate": "0",
                "recurrence_parent": null,
                "recurrence_child": null,
                "category_name": null,
                "swimlane_name": null,
                "project_name": "my project",
                "default_swimlane": "Default swimlane",
                "column_title": "Backlog",
                "assignee_username": null,
                "assignee_name": null,
                "creator_username": "user",
                "creator_name": ""
            },
            "changes": [],
            "author": "user",
            "event_title": "user created the task #1",
            "event_content": "\n<p class=\"activity-title\">\n    user created the task <a href=\"/?controller=task&amp;action=show&amp;task_id=1&amp;project_id=2\" class=\"\" title=\"\" >#1<\/a><\/p>\n<p class=\"activity-description\">\n    <em>my user title<\/em>\n<\/p>"
        }
    ]
}

```

--------------------------------

### PHP Info Test Page

Source: https://docs.kanboard.org/v1/admin/windows

Create this file to verify your PHP installation by visiting http://localhost/phpinfo.php.

```php
<?php

phpinfo();
?>

```

--------------------------------

### Listen to Kanboard Events

Source: https://docs.kanboard.org/v1/plugins/events

Use the `on()` method to subscribe to events. The first argument is the event name, and the second is a PHP callable.

```php
$this->on('app.bootstrap', function($container) {
    // Do something
});

```

--------------------------------

### Accessing Kanboard Classes

Source: https://docs.kanboard.org/v1/plugins/registration

Demonstrates how to access Kanboard's core classes and methods within a plugin, such as fetching user data.

```php
$this->user->getById(123);

```

--------------------------------

### Get Compatible Action Events for an Action

Source: https://docs.kanboard.org/v1/api/action_procedures

This procedure lists the events that are compatible with a specified automatic action. Provide the action's class name as a parameter to get the list of supported events.

```json
{
    "jsonrpc": "2.0",
    "method": "getCompatibleActionEvents",
    "id": 899370297,
    "params": [
        "\\Kanboard\\Action\\TaskClose"
    ]
}
```

```json
{
    "jsonrpc": "2.0",
    "id": 899370297,
    "result": {
        "bitbucket.webhook.commit": "Bitbucket commit received",
        "github.webhook.commit": "Github commit received",
        "github.webhook.issue.closed": "Github issue closed",
        "gitlab.webhook.commit": "Gitlab commit received",
        "gitlab.webhook.issue.closed": "Gitlab issue closed",
        "task.move.column": "Move a task to another column"
    }
}
```

--------------------------------

### Get all users

Source: https://docs.kanboard.org/v1/api/user_procedures

Retrieves a list of all available users.

```json
{
    "jsonrpc": "2.0",
    "method": "getAllUsers",
    "id": 1438712131
}
```

```json
{
    "jsonrpc": "2.0",
    "id": 1438712131,
    "result": [
        {
            "id": "1",
            "username": "biloute",
            "name": "",
            "email": "",
            "role": "app-user",
            "is_ldap_user": "0",
            "notifications_enabled": "0",
            "google_id": null,
            "github_id": null
        }
    ]
}
```
Tokens:
Raw