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

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

• STEP 4

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

• STEP 5

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 6

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'

services:
  planka:
    image: meltyshev/planka:latest
    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=notsecretkey
      - NODE_ENV=production
    depends_on:
      - postgres

  postgres:
    image: postgres
    restart: always
    volumes:
      - db-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=planka
      - POSTGRES_HOST_AUTH_METHOD=trust

volumes:
  user-avatars:
  project-background-images:
  attachments:
  db-data:

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.

• STEP 7

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.

• STEP 8

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

• STEP 9

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

• STEP 10

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.demoand the default password is demo

• STEP 11

Create your first Project!

Add your own background.

Change the default username and password.

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

This post was updated on Thursday / September 29th, 2022 at 5:24 PM