Kanboard Documentation

Requirements and Prerequisites

Prerequisites to install and use Kanboard.

Server Side

Compatible Operating Systems

  • Alpine Linux
  • Linux Ubuntu
  • Linux RHEL (RedHat, CentOS, Oracle Linux, RockyLinux, etc.)
  • Linux Debian
  • FreeBSD
  • Microsoft Windows
The recommended operating system is GNU/Linux (Debian/Ubuntu/RHEL/Alpine Linux).

Compatible Databases

  • SQLite >= 3.7
  • MySQL >= 5.6
  • MariaDB >= 10
  • PostgreSQL >= 9.4
  • Microsoft SQL Server (experimental - available since v1.2.25)

Which database to choose?

  • SQLite: For a single user or small teams (minimal concurrency).
  • MySQL/PostgreSQL: For larger teams or high-availability configurations.
  • The recommended database is PostgreSQL.
  • Do not use SQLite with NFS or Docker.

Compatible Web Servers

  • Apache HTTP Server
  • Nginx
  • Microsoft IIS
  • Caddy Server

Kanboard is pre-configured to work with Apache (URL rewriting).

  • Kanboard is NOT compatible with Apache mod_security.
  • If you use Apache, you must have the mod_version module enabled.

PHP Versions

  • PHP >= 8.1
  • Since version 1.2.22, Kanboard requires at least PHP 7.4.
  • Since version 1.2.13, Kanboard requires at least PHP 7.2.
  • Since version 1.2.46, Kanboard requires at least PHP 8.1. PHP 7.x is end-of-life and no longer supported.

Required PHP Extensions

  • pdo_sqlite (Only if you use SQLite)
  • pdo_mysql (Only if you use MySQL/MariaDB)
  • pdo_pgsql (Only if you use PostgreSQL)
  • gd
  • mbstring
  • openssl
  • json
  • hash
  • ctype
  • session
  • filter
  • xml
  • SimpleXML
  • dom

Optional PHP Extensions

  • zip: Used to install plugins from the web UI.
  • ldap: Only for LDAP integration.
  • curl: Used as an HTTP client.

Recommendations

  • A modern Linux or Unix operating system with the latest version of PHP.
  • Best performance is achieved with the latest version of PHP and OpCode caching enabled.

Client Side

Browsers

Always use a modern browser with the latest version:

  • Safari
  • Google Chrome
  • Mozilla Firefox
  • Microsoft Edge
The recommended browsers are Mozilla Firefox or Google Chrome.
Microsoft Internet Explorer is not supported since Kanboard version 1.2.11.

Devices

  • Laptop or desktop with a screen resolution >= 1366 x 768.
  • Tablet with a screen resolution >= 1024 x 768.

Note: Using Kanboard on a smartphone should work, but the board may not be practical to use on small screens.