kanboard

(β˜… 9,808)

Kanban project management software

Showing a partial file list β€” download the zip above to see everything.

  • .dockerignore
  • .gitattributes
  • .gitignore
  • .htaccess
  • .php-cs-fixer.php
  • ChangeLog
  • cli
  • composer.json
  • composer.lock
  • config.default.php
  • CONTRIBUTING.md
  • docker-compose.mysql.yml
  • docker-compose.postgres.yml
  • docker-compose.sqlite.yml
  • Dockerfile
  • favicon.ico
  • healthcheck.php
  • index.php
  • jsonrpc.php
  • LICENSE
  • Makefile
  • README.md
  • robots.txt
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/kanboard/kanboard

Downloads the entire project code from GitHub to your computer.

cd kanboard

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
- [Use Kanboard with Docker](https://docs.kanboard.org/v1/admin/docker/)

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
composer install

Installs the PHP libraries listed in composer.json.

βœ… Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation