How to Install Planka on Your Synology NAS

How to Install Planka on Your Synology NAS

Planka is a free open source Trello-like kanban board for workgroups built with React and Redux. In this step by step guide I will show you how to install Planka on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Planka v1.17.4 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.

Planka Synology NAS Set up 1 new 2023

  • STEP 5

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

Planka Synology NAS Set up 2 new 2023

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3617

Planka 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 tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

Planka Synology NAS Set up 4 new 20

  • STEP 9

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

Planka Synology NAS Set up 5 new 2023

  • STEP 10

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

Planka Synology NAS Set up 1 new

  • STEP 11

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

Planka Synology NAS Set up 2 new

  • STEP 12

Right click on the planka folder that you have previously created at STEP 10 then click Properties. Follow the instructions in the image below.

Planka Synology NAS Set up 3 new 2023

  • STEP 13

Go to the Permission tab then click Advanced options. From the drop-down menu choose “Make inherited permissions explicit“. Follow the instructions in the image below.

Planka Synology NAS Set up 4 new 2023

  • STEP 14

Select Everyone then click the Edit tab. Follow the instructions in the image below.

Planka Synology NAS Set up 5 new 2023

  • STEP 15

Check all Read and Write Permissions. Click Done. Follow the instructions in the image below.

Planka Synology NAS Set up 6 new 2023

  • STEP 16

After you click Done on STEP 15, check “Apply to this folder, sub-folders and files“. Click Save. Follow the instructions in the image below.

Planka Synology NAS Set up 7 new 2023

  • STEP 17

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 18

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

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

version: '3.9'
services:
  planka:
    image: ghcr.io/plankanban/planka:latest
    container_name: Planka
    command: >
      bash -c
        "for i in `seq 1 30`; do
          ./start.sh &&
          s=$$? && break || s=$$?;
          echo \"Tried $$i times. Waiting 5 seconds...\";
          sleep 5;
        done; (exit $$s)"
    restart: on-failure:5
    volumes:
      - /volume1/docker/planka/avatars:/app/public/user-avatars
      - /volume1/docker/planka/images:/app/public/project-background-images
      - /volume1/docker/planka/files:/app/private/attachments
    ports:
      - 3617:1337
    environment:
      - BASE_URL=https://planka.yourname.synology.me
      - TRUST_PROXY=0
      - DATABASE_URL=postgresql://postgres@postgres/planka
      - SECRET_KEY=MariushostingMariushostingMari13
      - DEFAULT_ADMIN_EMAIL=yourown@email
      - DEFAULT_ADMIN_PASSWORD=mariushosting
      - DEFAULT_ADMIN_NAME=marius
      - DEFAULT_ADMIN_USERNAME=marius
      - NODE_ENV=production
    depends_on:
      - postgres

  postgres:
    image: postgres
    container_name: Planka-DB
    restart: on-failure:5
    volumes:
      - /volume1/docker/planka/db:/var/lib/postgresql/data:rw
    environment:
      - POSTGRES_DB=planka
      - POSTGRES_HOST_AUTH_METHOD=trust

Note: Before you paste the code above in the Web editor area below, change the value for BASE_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for SECRET_KEY and add your own SECRET KEY. MariushostingMariushostingMari13 is an example for a SECRET_KEY. You should invent your own Value. Add 32 random characters, both letters and numbers.
Note: Before you paste the code above in the Web editor area below, change the value for DEFAULT_ADMIN_EMAIL and type in your own email. You will need this email later at STEP 22.
Note: Before you paste the code above in the Web editor area below, change the value for DEFAULT_ADMIN_PASSWORD and type in your own admin password. mariushosting is an example for a password. You will need this password later at STEP 22.
Note: Before you paste the code above in the Web editor area below, change the value for DEFAULT_ADMIN_NAME and type in your own name. marius is an example for an name.
Note: Before you paste the code above in the Web editor area below, change the value for DEFAULT_ADMIN_USERNAME and type in your own username. marius is an example for an username.

Planka Synology NAS Set up 6 new 2024

  • STEP 19

Scroll down on the page until you see a button called 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.

Planka Synology NAS Set up 7 new 2024

  • STEP 20

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

Planka Synology NAS Set up 8 new 2023

  • STEP 21

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

  • STEP 22

Now open your browser and type in your HTTPS/SSL certificate like this https://planka.yourname.synology.me In my case it’s https://planka.mariushosting.synology.me If everything goes right, you will see the Planka Login page. Type in your own email (DEFAULT_ADMIN_EMAIL) and password (DEFAULT_ADMIN_PASSWORD) that you have previously created at STEP 18.

Planka Synology NAS Set up 8 new 2024

  • STEP 23

Create your first Project! Click Create project then give a name to your project. Follow the instructions in the image below.

Planka Synology NAS Set up 11 new 2023

  • STEP 24

At the top left of the page click on the project name then add your own background. Follow the instructions in the image below.

Planka Synology NAS Set up 12 new 2023

  • STEP 25

Your Planka dashboard at a glance!

Planka Synology NAS Set up 13 new 2023

Enjoy Planka!

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 Planka container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: There is also an alternative to Planka called Focalboard.
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 / May 27th, 2024 at 8:53 PM