Kanboard is a free and open source Kanban project management software. Kanboard is an extremely simple kanban board, but still so powerful, elegant, and the updates are very frequent. In this step by step guide I will show you how to install Kanboard on your Synology NAS using Docker and Portainer.

💡Note: This guide works perfectly with the latest Kanboard v1.2.39 release.

• STEP 1

Please Support My work by Making a Donation.

• STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

• STEP 3

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

• STEP 4

Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.

• STEP 5

Now click the “Create” button. Follow the instructions in the image below.

• STEP 6

After you click the Create button, the window below will open. Follow the instructions in the image below.

On the General area, set the Reverse Proxy Name description: type in kanboard. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: kanboard.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 7565

• STEP 7

On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.

• STEP 8

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

• STEP 9

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.

• STEP 10

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it kanboard. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 11

Now create four new folders inside the kanboard folder that you created at STEP 10 and name them data, db, plugins, ssl. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 12

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

• STEP 13

In the Name field type in kanboard. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: '3.9'
services:
  kanboard:
    image: kanboard/kanboard:latest
    container_name: Kanboard
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/80' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    ports:
      - 7565:80
    volumes:
      - /volume1/docker/kanboard/data:/var/www/app/data:rw
      - /volume1/docker/kanboard/plugins:/var/www/app/plugins:rw
      - /volume1/docker/kanboard/ssl:/etc/nginx/ssl:rw
    environment:
      DATABASE_URL: mysql://kanboard:kanboard-secret@db/kanboard
      PLUGIN_INSTALLER: true
      
  db:
    image: mysql:9
    container_name: Kanboard-DB
    environment:
      MYSQL_ROOT_PASSWORD: secret
      MYSQL_DATABASE: kanboard
      MYSQL_USER: kanboard
      MYSQL_PASSWORD: kanboard-secret
    volumes:
    - /volume1/docker/kanboard/db:/var/lib/mysql:rw

• STEP 14

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

• STEP 15

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

• STEP 16

Go back to STEP 1 or you will deal with karma 🙂.

• STEP 17

Please wait approximately 10-15 minutes for the installation to be completed or you will get a blank page with an error if you try to connect too soon. Now open your browser and type in your HTTPS/SSL certificate like this https://kanboard.yourname.synology.me In my case it’s https://kanboard.mariushosting.synology.me If everything goes right, you will see the kanboard login page. Add the default username and password then click Sign in. Follow the instructions in the image below. 

⚠️Warning: the default username is admin and the default password is admin

• STEP 18

Your Kanboard dashboard will look like this.

• STEP 19

Change the default password. At the top right of the page click on “My profile” then Change Password. Change your current admin password then click Save. You can also change the default username in the left sidebar menu. Follow the instructions in the image below.

Enjoy Kanboard!

Note: Find out how to update the Kanboard container with the latest image.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Sunday / August 25th, 2024 at 1:25 PM