How to Install Kaneo on Your Synology NAS

by

How to Install Kaneo on Your Synology NAS

Kaneo is an open source project management platform focused on simplicity and efficiency. In this step by step guide I will show you how to install Kaneo on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Kaneo v0.3.0 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 / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

Kaneo Synology NAS Set up 1

  • STEP 5

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

Kaneo Synology NAS Set up 2

  • STEP 6

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

Kaneo Synology NAS Set up 3

  • STEP 7

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

Kaneo Synology NAS Set up 4

  • STEP 8

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 Kaneo. After that, add the following instructions:

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 5173

Kaneo Synology NAS Set up 5

  • STEP 9

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.

Synology Proxy WebSocket

  • STEP 10

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

Kaneo Synology NAS Set up 6

  • STEP 11

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

Kaneo Synology NAS Set up 7

  • STEP 12

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 ApiKaneo. After that, add the following instructions:

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 1337

Kaneo Synology NAS Set up 8

  • STEP 13

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.

Synology Proxy WebSocket

  • STEP 14

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

Kaneo Synology NAS Set up 9

  • STEP 15

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.

1 Synology Portainer Add Stack

  • STEP 16

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

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

services:
  kaneo:
    image: ghcr.io/usekaneo/api:node-new
    user: 0:0
    container_name: Kaneo-API
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 1337 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    environment:
      JWT_ACCESS: dOxZYTTZgXKMHkqLBIQVImayQXAVWdzGBPuFJKggzcgvgPJPXpWzqzKaUOIOGGIr
      DB_PATH: /app/apps/api/data/kaneo.db
    ports:
      - 1337:1337
    volumes:
      - /volume1/docker/kaneodb:/app/apps/api/data:rw
    restart: on-failure:5

  frontend:
    image: ghcr.io/usekaneo/web:node-new
    user: 0:0
    container_name: Kaneo
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 5173 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    environment:
      KANEO_API_URL: https://apikaneo.yourname.synology.me
      ALLOW_REGISTRATION: true #or false to disable user registration after first user registration.
    ports:
      - 5173:5173
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for JWT_ACCESS. (Generate your own Random 64 length JWT_ACCESS.)
Note: Before you paste the code above in the Web editor area below, change the value for KANEO_API_URL and type in your own your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 12.

Kaneo Synology NAS Set up 10

  • STEP 17

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.

Kaneo Synology NAS Set up 11

  • STEP 18

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

Kaneo Synology NAS Set up 12

  • STEP 19

🟢Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guides forget to support my work, or just ignore STEP 1. I’ve been very honest about this aspect of my work since the beginning: I don’t run any ADS, I don’t require subscriptions, paid or otherwise, I don’t collect IPs, emails, and I don’t have any referral links from Amazon or other merchants. I also don’t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. It’s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

  • STEP 20

Now open your browser and type in your HTTPS/SSL certificate that you have previously created at STEP 8 https://kaneo.yourname.synology.me in my case https://kaneo.mariushosting.synology.me Click Create account. Follow the instructions in the image below.

Kaneo Synology NAS Set up 13

  • STEP 21

Type in your own details then click Sign up. Follow the instructions in the image below.

Kaneo Synology NAS Set up 14

  • STEP 22

Your Kaneo dashboard at a glance!

Kaneo Synology NAS Set up 15

Enjoy Kaneo!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the Kaneo container with the latest image.
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 Monday / April 21st, 2025 at 11:13 PM

🧡 I Need Your Help!