NodeBB is the next generation community forum platform. It’s built on open source software. It’s used for creating discussion forums, community sites, customer support platforms, or any scenario where interaction and discussion among users are needed. In this step by step guide I will show you how to install NodeBB on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest NodeBB v4.0.0 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 NodeBB. After that, add the following instructions:

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 4568

• 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 / 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 nodebb. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 11

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

• STEP 12

Download (click on the blue link below) and upload the setup.json file below in the nodebb folder that you have previously created at STEP 10. 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!

👉🏻setup.json

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

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

services:
  nodebb:
    image: ghcr.io/nodebb/nodebb:latest
    container_name: NodeBB
    restart: on-failure:5
    ports:
      - 4568:4567
    volumes:
      - /volume1/docker/nodebb/build:/usr/src/app/build:rw
      - /volume1/docker/nodebb/uploads:/usr/src/app/public/uploads:rw
      - /volume1/docker/nodebb/config:/opt/config:rw
      - /volume1/docker/nodebb/setup.json:/usr/src/app/setup.json:rw
    depends_on:
     - db
     - redis
     
  redis:
    image: redis:7.4.2-alpine
    container_name: NodeBB-REDIS
    healthcheck:
     test: ["CMD-SHELL", "redis-cli ping || exit 1"]
    command: ['redis-server', '--appendonly', 'yes', '--loglevel', 'warning']
    volumes:
      - /volume1/docker/nodebb/redis:/data:rw
    restart: on-failure:5

  db:
    image: postgres:17-alpine
    container_name: NodeBB_DB
    hostname: nodebb-db
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "nodebb", "-U", "nodebbuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    environment:
      POSTGRES_USER: nodebbuser
      POSTGRES_PASSWORD: nodebbpass
      POSTGRES_DB: nodebb
    volumes:
      - /volume1/docker/nodebb/db:/var/lib/postgresql/data:rw
    restart: on-failure:5

• STEP 15

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 16

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

• STEP 17

Please wait approximately 2 minutes or you will get a blank synology error page if you try to connect too soon. Now open your browser and type in your HTTPS/SSL certificate like this https://nodebb.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://nodebb.mariushosting.synology.me If everything goes right, you will see the NodeBB Installation page. In the Web Address (URL) field, type in your own synology.me DDNS address with https:// at the beginning. Create your Administrator account using your own credentials. Scroll down the page. Follow the instructions in the image below.

• STEP 18

Select the PostgreSQL database, then click Test Database. Click Install NodeBB. Follow the instructions in the image below.

• STEP 19

Your NodeBB installation will start. Go straight to the next STEP.

• STEP 20

Wait until the progress blue line gets to the end. When this happens, go straight to the next STEP. ⚠️Warning: Even though it says you will be redirected once your forum is ready, nothing will happen. So, go straight to the next STEP.

• STEP 21

Open Portainer, then go to Containers. Select the NodeBB container that is marked in red, then click Restart. Follow the instructions in the image below.

• STEP 22

Now open your browser and type in your HTTPS/SSL certificate like this https://nodebb.yourname.synology.me/login that you have previously created at STEP 6. In my case it’s https://nodebb.mariushosting.synology.me/login Type in your own Email address and Password that you have previously added at STEP 17, then click Login. Follow the instructions in the image below.

• STEP 23

As you can see, you are the Administrator of your Forum!

• STEP 24

On the left sidebar, click Appearance, then Skins. Select your favorite skin. Follow the instructions in the image below.

• STEP 25

Your Forum at a glance!

• STEP 26

Your First Post at a glance!

• STEP 27

Set Up Email Notifications on NodeBB.

Enjoy NodeBB!

🆘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 NodeBB 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.

This post was updated on Wednesday / January 22nd, 2025 at 1:38 AM