Install Node-RED on Your Synology NAS with Docker Compose

by

Install Node-RED on Your Synology NAS with Docker Compose

Do you remember my guide on How to Install Node-RED on your Synology NAS using the integrated Synology Task Scheduler for the installation? Today I will show you how to install Node-RED on your Synology NAS with Docker Compose using Docker and Portainer. As you well know, Node-RED is a flow-based development tool for visual programming developed originally by IBM for wiring together hardware devices, APIs and online services as part of the Internet of Things. Node-RED provides a web browser-based flow editor, which can be used to create JavaScript functions.

💡Note: This guide works perfectly with the latest Node-RED 4.0.5 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

Install Text Editor via Synology “Package Center”. If you already have Text Editor installed on your Synology NAS, skip this STEP.

Synology Install Text Editor 2023

  • STEP 4

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

Synology NAS Node-Red Docker Compose Install 1

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

1 Synology Portainer Add Stack

  • STEP 6

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

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

version: "3.9"
services:
  node-red:
    image: nodered/node-red:latest
    container_name: Node-RED
    hostname: node-red
    mem_limit: 1g
    mem_reservation: 128m
    cpu_shares: 1024
    security_opt:
      - no-new-privileges:true
    read_only: true
    user: 1026:100
    ports:
      - 6336:1880
    volumes:
      - /volume1/docker/node-red:/data:rw
    environment:
      TZ: Europe/Bucharest
    restart: on-failure:5

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

Synology NAS Node-Red Docker Compose Install 2

  • STEP 7

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.

Synology NAS Node-Red Docker Compose Install 3

  • STEP 8

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

Synology NAS Node-Red Docker Compose Install 4

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

Synology NAS Node-Red Docker Compose Install 5

Enjoy Node-RED!

Note: If you want to protect your Node-RED installation with a Username and Password, check out the official documentation on how to do it. You will need to modify the settings.js file that you will find in your volume1/docker/nodered folder. To open the settings.js file and start modifying it, you need Synology Text Editor installed on your Synology NAS as per the instructions at STEP 3. Once you have modified the settings.js file, remember to restart the Node-RED container.

Note: If you want to run the Node-RED container over HTTPS, check my guide on How to Run Docker Containers Over HTTPS.

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 Node-RED 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 / October 13th, 2024 at 6:34 PM

🧡 I Need Your Help!