How to Install 4GABOARDS on Your Synology NAS

by

How to Install 4GABOARDS on Your Synology NAS

4GABOARDS is a Kanban board inspired by the discontinued Gitkraken Glo Boards. You can easily create projects, boards, lists, cards, labels and tasks. In this step by step guide I will show you how to install 4GABOARDS on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest version of 4GABOARDS v3.1.4

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

4GABOARDS Synology NAS Set up 1

  • STEP 5

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

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

Source:
Protocol: HTTPS
Hostname: 4gaboards.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3713

4GABOARDS Synology NAS Set up 3

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

4GABOARDS Synology NAS Set up 4

  • STEP 9

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

4GABOARDS Synology NAS Set up 5

  • STEP 10

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

4GABOARDS Synology NAS Set up 6

  • STEP 11

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

4GABOARDS Synology NAS Set up 7

  • STEP 12

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

4GABOARDS Synology NAS Set up 8

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

4GABOARDS Synology NAS Set up 9

  • STEP 14

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

4GABOARDS Synology NAS Set up 10

  • STEP 15

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

4GABOARDS Synology NAS Set up 11

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

4GABOARDS Synology NAS Set up 12

  • 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 4gaboards. Follow the instructions in the image below.

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

services:
  db:
    image: postgres:17
    container_name: 4GABOARDS-DB
    hostname: 4gaboards-db
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "4gaboards", "-U", "4gaboardsuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/4gaboards/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: 4gaboards
      POSTGRES_USER: 4gaboardsuser
      POSTGRES_PASSWORD: 4gaboardspass
    restart: on-failure:5

  4gaBoards:
    image: ghcr.io/rargames/4gaboards:latest
    container_name: 4GABOARDS
    restart: on-failure:5
    volumes:
      - /volume1/docker/4gaboards/avatars:/app/public/user-avatars:rw
      - /volume1/docker/4gaboards/backgrounds:/app/public/project-background-images:rw
      - /volume1/docker/4gaboards/files:/app/private/attachments:rw
    ports:
      - 3713:1337
    environment:
      BASE_URL: https://4gaboards.yourname.synology.me
      SECRET_KEY: iLE3qPl8jJZWSrmSJGERVQt6YKIQIoUT
      DATABASE_URL: postgresql://4gaboardsuser:4gaboardspass@4gaboards-db/4gaboards
      NODE_ENV: production
    depends_on:
      db:
        condition: service_healthy

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. (Generate your own 32 length SECRET_KEY.)

4GABOARDS Synology NAS Set up 13

  • STEP 19

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.

4GABOARDS Synology NAS Set up 14

  • STEP 20

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

4GABOARDS Synology NAS Set up 15

  • 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://4gaboards.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://4gaboards.mariushosting.synology.me Type in the default Username and Password, then click Log in.

⚠️Warning: the default username is demo and the default password is demo

. Follow the instructions in the image below.

4GABOARDS Synology NAS Set up 16

  • STEP 23

At the top right of the page, click on the user icon then Authentication to change the default Username and Password. Follow the instructions in the image below.

4GABOARDS Synology NAS Set up 17

  • STEP 24

Your 4GABOARDS instance at a glance!

4GABOARDS Synology NAS Set up 18

Enjoy 4GABOARDS!

🆘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: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the 4GABOARDS 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 Monday / December 2nd, 2024 at 9:49 PM

🧡 I Need Your Help!