How to Install NocoBase on Your Synology NAS

How to Install NocoBase on Your Synology NAS

NocoBase is a private no-code platform. With NocoBase you have total control, infinite scalability, and you can empower your team to swiftly adapt to changes and significantly reduce costs. Skip years of development and millions in investment. In this step by step guide I will show you how to install NocoBase on your Synology NAS using Docker and Portainer.

💡Note: This guide works perfectly with the latest NocoBase v0.21.0-alpha.13 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.

NocoBase Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 13000

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

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

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

NocoBase Synology NAS Set up 6

  • STEP 11

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 12

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

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

version: "3.9"
services:
  db:
    image: postgres:16
    container_name: NocoBase-DB
    hostname: nocobase-db
    mem_limit: 1g
    cpu_shares: 1024
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "nocobase", "-U", "nocobaseuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/nocobasedb:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: nocobase
      POSTGRES_USER: nocobaseuser
      POSTGRES_PASSWORD: nocobasepass
    restart: on-failure:5

  nocobase:
    image: nocobase/nocobase:latest
    container_name: NocoBase
    ports:
      - 13000:80
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/80' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    depends_on:
      - db
    environment: 
      APP_KEY: fxeehek3ovEqWH6qjsaBzOFHJlUZ0A3A
      DB_DIALECT: postgres
      DB_HOST: nocobase-db
      DB_DATABASE: nocobase
      DB_USER: nocobaseuser
      DB_PASSWORD: nocobasepass

Note: Before you paste the code above in the Web editor area below, change the value for APP_KEY and add your own APP_KEY. fxeehek3ovEqWH6qjsaBzOFHJlUZ0A3A is an example for an APP_KEY. You need to add your own 32 string value using this free online tool.

NocoBase Synology NAS Set up 7

  • STEP 13

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.

NocoBase Synology NAS Set up 8

  • STEP 14

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

NocoBase Synology NAS Set up 9

  • STEP 15

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

  • STEP 16

Now open your browser and type in your HTTPS/SSL certificate like this https://nocobase.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://nocobase.mariushosting.synology.me If everything goes right, you will see the NocoBase login page. Type in the default username and password, then click Sign in. Follow the instructions in the image below.

⚠️Warning: the default username is admin@nocobase.com and the default password is admin123

NocoBase Synology NAS Set up 10

  • STEP 17

At the top right of the page, click on the user icon, then Change password. Follow the instructions in the image below.

NocoBase Synology NAS Set up 11

  • STEP 18

Type in your old default admin123 password, then type in your new password. Click Submit. Follow the instructions in the image below.

NocoBase Synology NAS Set up 12

  • STEP 19

Your NocoBase dashboard at a glance!

NocoBase Synology NAS Set up 13

Enjoy NocoBase!

🆘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 NocoBase 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 / April 21st, 2024 at 2:29 PM