Plane is an open-source software development tool to manage issues, sprints, and product roadmaps with peace of mind. It allows users to start with a basic task tracking tool and gradually adopt various project management frameworks like Agile, Waterfall, and many more. In this step by step guide I will show you how to install Plane on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Plane v0.12.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. 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.

• STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3356

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

• STEP 8

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

• STEP 9

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

• STEP 10

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

• STEP 11

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

• STEP 12

Follow my step by step guide on how to activate SMTP for your Gmail account. This step is mandatory. Note: If you don’t want to use the easiest way for SMTP with Google and you already have SMTP details from your own Mail Server, you can just skip this STEP and use your personalized email SMTP details instead.

• STEP 13

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 14

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

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

version: "3.9"
services:
  redis:
    image: redis
    container_name: Plane-REDIS
    hostname: plane-redis
    mem_limit: 256m
    mem_reservation: 50m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    read_only: true
    user: 1026:100
    healthcheck:
      test: ["CMD-SHELL", "redis-cli ping || exit 1"]
    volumes:
      - /volume1/docker/plane/redis:/data:rw
    environment:
      TZ: Europe/Bucharest
    restart: on-failure:5

  db:
    image: postgres
    command: postgres -c 'max_connections=1000'
    container_name: Plane-DB
    hostname: plane-db
    mem_limit: 512m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "plane", "-U", "planeuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/plane/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: plane
      POSTGRES_USER: planeuser
      POSTGRES_PASSWORD: planepass
    restart: on-failure:5

  minio:
    image: minio/minio:latest
    command: server /export --console-address ":9090"
    container_name: Plane-MINIO
    hostname: plane-minio
    mem_limit: 2g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    healthcheck:
      test: curl -f http://localhost:9090/ || exit 1
    volumes:
      - /volume1/docker/plane/uploads:/export:rw
      - /volume1/docker/plane/uploads:/data:rw
    environment:
      MINIO_ROOT_USER: ${AWS_ACCESS_KEY_ID}
      MINIO_ROOT_PASSWORD: ${AWS_SECRET_ACCESS_KEY}
    restart: on-failure:5

  createbuckets:
    image: minio/mc:latest
    entrypoint: >
      /bin/sh -c " /usr/bin/mc config host add plane-minio http://plane-minio:9000 \$AWS_ACCESS_KEY_ID \$AWS_SECRET_ACCESS_KEY; 
      /usr/bin/mc mb plane-minio/\$AWS_S3_BUCKET_NAME; 
      /usr/bin/mc anonymous set download plane-minio/\$AWS_S3_BUCKET_NAME; exit 0; "
    container_name: Plane-CREATE
    hostname: plane-create
    security_opt:
      - no-new-privileges:true
    depends_on:
      minio:
        condition: service_healthy

  back:
    image: makeplane/plane-backend:latest
    command: ./bin/takeoff
    container_name: Plane-BACK
    hostname: planebackend
    mem_limit: 2g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    healthcheck:
      test: wget --no-verbose --tries=1 --spider http://localhost:8000
    env_file:
      - stack.env
    restart: on-failure:5
    depends_on:
      redis:
        condition: service_healthy
      db:
        condition: service_healthy

  worker:
    image: makeplane/plane-worker:latest
    command: ./bin/worker
    container_name: Plane-WORKER
    hostname: planerqworker
    mem_limit: 2g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    env_file:
      - stack.env
    restart: on-failure:5
    depends_on:
      redis:
        condition: service_healthy
      db:
        condition: service_healthy
      back:
        condition: service_healthy

  front:
    image: makeplane/plane-frontend:latest
    command: /usr/local/bin/start.sh
    container_name: Plane-FRONT
    hostname: planefrontend
    mem_limit: 2g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: stat /etc/passwd || exit 1
#    env_file:
#      - stack.env
    environment:
      NEXT_PUBLIC_API_BASE_URL: https://plane.yourname.synology.me
      NEXT_PUBLIC_GOOGLE_CLIENTID: 0
      NEXT_PUBLIC_GITHUB_APP_NAME: 0
      NEXT_PUBLIC_GITHUB_ID: 0
      NEXT_PUBLIC_SENTRY_DSN: 0
      NEXT_PUBLIC_ENABLE_OAUTH: 0
      NEXT_PUBLIC_ENABLE_SENTRY: 0

    restart: on-failure:5
    depends_on:      
      back:
        condition: service_healthy
      worker:
        condition: service_started

  proxy:
    image: makeplane/plane-proxy:latest
    container_name: Plane-PROXY
    hostname: planeproxy
    mem_limit: 512m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    ports:
      - 3356:80
#    env_file:
#      - stack.env
    environment:
      FILE_SIZE_LIMIT: ${FILE_SIZE_LIMIT}
      BUCKET_NAME: ${AWS_S3_BUCKET_NAME}
    depends_on:      
      back:
        condition: service_started
      front:
        condition: service_healthy

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 TZ. (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area below, change the value for NEXT_PUBLIC_API_BASE_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.

• STEP 15

Click the Upload button after Web editor. Download the stack.env file by clicking the blue link below and then upload it from your computer in the “Load variables from .env files“. Follow the instructions in the image below. 🔒Note: Support my work to unlock the password. You can use this password to download any file on mariushosting forever!

👉🏻Download stack.env file

• STEP 16

Note: On the Environment variables change the value for DEFAULT_EMAIL type in your own Email Address. You will need this email later at STEP 21. 🔵
Note: On the Environment variables change the value for DEFAULT_PASSWORD type in your own Password. You will need this password later at STEP 21. 🟣
Note: On the Environment variables change the value for WEB_URL. Type in your own synology.me DDNS that you have previously created at STEP 6 with https at the beginning. 🟢
Note: On the Environment variables change the value for EMAIL_HOST_USER. Type in your own Gmail Address. STEP 12. 🟠
Note: On the Environment variables change the value for EMAIL_HOST_PASSWORD. Type in your Gmail App Password. STEP 12. 🟡

⚠️Warning: Do not change any of the other values. All the values should be inside ” “.

• STEP 17

After you made the changes, click the Web editor button. Follow the instructions in the image below.

• STEP 18

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.

⌛Now just wait because the Plane image is about 2GB.

• STEP 19

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“. ⚠️ Note: You will have a total of 8 Containers. The PLANE-CREATE container serves only to launch Plane; after that, its status in Portainer will be marked in red as “exited“. This is how it works. Not all containers are the same. Go to the next STEP.

• STEP 20

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

• STEP 21

Now open your browser and type in your HTTPS/SSL certificate like this https://plane.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://plane.mariushosting.synology.me If everything goes right, you will see the Plane Login page. Type in your own Email Address and Password that you have previously created at STEP 16. Click Sign In. Follow the instructions in the image below.

• STEP 22

Type in your First and Last name, then select your role. Click Continue. Follow the instructions in the image below.

• STEP 23

In the Workspace Name area type in a name for your Workspace, then click Create Workspace. Follow the instructions in the image below.

• STEP 24

Invite co-workers or click Skip this step to add them later. Follow the instructions in the image below.

• STEP 25

Explore Plane. Follow the instructions in the image below.

• STEP 26

Your Plane Dashboard at a glance!

• STEP 27

At the top left of the page click on your Profile icon then Settings. Follow the instructions in the image below.

• STEP 28

Update your profile, then click Update profile. Follow the instructions in the image below.

• STEP 29

Click Add Project or Create Project to create your first project. Follow the instructions in the image below.

• STEP 30

On the left sidebar click Analytics to see your Plane stats at a glance!

Enjoy Plane!

🆘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: Find out how to update the Plane 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 Sunday / September 17th, 2023 at 1:39 PM