How to Install Wekan on Your Synology NAS

How to Install Wekan on Your Synology NAS

Wekan is a completely Open Source and Free software collaborative kanban board application with MIT license. Whether you’re maintaining a personal to-do list, planning your holidays with some friends, or working in a team on your next revolutionary idea, Kanban boards are an unbeatable tool to keep your things organized. They give you a visual overview of the current state of your project, and make you productive by allowing you to focus on the few items that matter the most. In this step by step guide I will show you how to install Wekan on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Wekan v6.89 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.

Wekan Synology NAS Set up 1

  • STEP 5

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

Wekan Synology NAS Set up 2

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 7686

Wekan Synology NAS Set up 3 new 2023

  • 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.

Synology Proxy WebSocket

  • STEP 8

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

Wekan Synology NAS Set up 4b

  • STEP 9

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

Wekan Synology Docker HTTP Compression

  • STEP 10

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

Wekan Synology NAS Set up 4 new 2023

  • STEP 11

Now create three new folders inside the wekan folder that you created at STEP 10 and name them configdb, data, db, dump. Follow the instructions in the image below.
Note: Be careful enter only lowercase, not uppercase letters.

Wekan Synology NAS Set up 5 new 2023

  • STEP 12

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

1 Synology Portainer Add Stack

  • STEP 13

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

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

version: "3.9"
services:
  db:
    image: mongo:6
    container_name: Wekan-DB
    hostname: wekan-db
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "mongosh", "--eval", "db.adminCommand('ping')"]
      interval: 10s
      timeout: 10s
      retries: 5
      start_period: 20s
    environment:
      - PUID=1026
      - PGID=100
    volumes:
      - /volume1/docker/wekan/db:/data/db
      - /volume1/docker/wekan/configdb:/data/configdb
      - /volume1/docker/wekan/dump:/dump
    restart: always

  wekan:
    image: wekanteam/wekan
    container_name: Wekan
    hostname: wekan
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    ports:
      - 7686:8080
    volumes:
      - /etc/localtime:/etc/localtime:ro
      - /volume1/docker/wekan/data:/data
    environment:
      - MONGO_URL=mongodb://wekan-db:27017/wekan
      - ROOT_URL=https://wekan.yourname.synology.me/
      - BROWSER_POLICY_ENABLED=true
    restart: always
    depends_on:
      db:
        condition: service_healthy

Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own PUID and PGID values. (Follow my step by step guide on how to do this.) 1026 is my personal PUID value and 100 is my personal PGID value. You have to type in your own values.
Note: Before you paste the code above in the Web editor area below, change the value numbers for user with your own UID and GID values. (Follow my step by step guide on how to do this.) 1026 is my personal UID value and 100 is my personal GID value. You have to type in your own values.
Note: Before you paste the code above in the Web editor area below, change the value for ROOT_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6. Note: Don’t forget to add the slash / at the end of the URL.

Wekan Synology NAS Set up 6 new 2023

  • 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.

Wekan Synology NAS Set up 7 new 2023

  • STEP 15

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

Wekan Synology NAS Set up 8 new 2023

  • STEP 16

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

  • STEP 17

Now open your browser and type in your HTTPS/SSL certificate like this https://wekan.yourname.synology.me In my case it’s https://wekan.mariushosting.synology.me If everything goes right, you will see the wekan login page. Click Register. Follow the instructions in the image below.

Wekan Synology NAS Set up 13

  • STEP 18

Add your own Username, your own Email and your own Password then click Register. Follow the instructions in the image below. Note: If you get an Internal server error message, ignore it then click sign in with the user you have created.

Wekan Synology NAS Set up 14

  • STEP 19

Disable registration of new users in Wekan. At the top right of the page click Admin Panel. Follow the instructions in the image below.

Wekan Synology NAS Set up 15

  • STEP 20

In the menu on the left select “Registration“, then Disable Self-Registration. Follow the instructions in the image below.

Wekan Synology NAS Set up 16

Your Wekan dashboard at a glance!

Wekan Synology NAS Set up 17

Enjoy Wekan!

Note: Find out how to update the Wekan container with the latest image.
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 Saturday / May 13th, 2023 at 12:27 AM