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

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 4

Now create four new folders inside the planka folder that you created at STEP 3 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 5

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

Planka Synology NAS Set up 3 new 2023

  • STEP 6

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 7

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

Planka Synology NAS Set up 5 new 2023

  • STEP 8

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

Planka Synology NAS Set up 6 new 2023

  • STEP 9

After you click Done on STEP 8, 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 10

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 11

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: always
    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=http://192.168.1.18:3617
      - TRUST_PROXY=0
      - DATABASE_URL=postgresql://postgres@postgres/planka
      - SECRET_KEY=MariushostingMariushostingMari13
      - NODE_ENV=production
    depends_on:
      - postgres

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

Note: Before you paste the code above in the Run command area, change the value for BASE_URL and add your LOCAL NAS IP instead of 192.168.1.18 which is my own Local NAS IP.
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.

Planka Synology NAS Set up 3 new

  • STEP 12

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 4 new 2023

  • STEP 13

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 5 new

  • STEP 14

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

  • STEP 15

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser and type in http://Synology-ip-address:3617 Follow the instructions in the image below. Type in the default Username and Password, then click Log in.

Warning: the default username is demo@demo.demo and the default password is demo

Planka Synology NAS Set up 6 new

  • STEP 16

Create your first Project!

Planka Synology NAS Set up 8

Add your own background.

Planka Synology NAS Set up 9

At the right of the page click “Demo Demo” then Settings to change the default username and password.

Planka Synology NAS Set up 10

Note: If you want to run the Planka container over an HTTPS connection, check out my guide on How to Run Docker Containers Over HTTPS. Also remember to change the value for BASE_URL at STEP 11 and add your own wildcard certificate address like this: planka.yourname.synology.me instead of http://localnasIP:3617 which is your own Local NAS IP.

Note: Can I run Docker on my Synology NAS? See the supported models.
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 Tuesday / January 24th, 2023 at 6:51 PM