How to Install FlowiseAI on Your Synology NAS

How to Install FlowiseAI on Your Synology NAS

FlowiseAI is an Open Source Graphic User Interface to build your customized LLM flow on LangChain. LLM (Large Language Model): A large language model (LLM) is a deep learning algorithm that can perform a variety of natural language processing (NLP) tasks. These models (also referred to as neural networks) are typically built on transformer architectures and are characterized by their extensive training on massive datasets. Large language models (LLMs) like GPT-3 and similar models can be used to develop a variety of applications across different domains e.g. LLM Chains, GenApps, Prompt Chaining etc. In this step by step guide I will show you how to install FlowiseAI on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest FlowiseAI v.1.8.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.

FlowiseAI Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8459

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

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

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

FlowiseAI Synology NAS Set up 6

  • STEP 11

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

FlowiseAI Synology NAS Set up 7

  • STEP 12

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 13

In the Name field type in flowiseai. 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
    container_name: FlowiseAI-DB
    hostname: flowise-db
    mem_limit: 1g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "flowise", "-U", "flowiseuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/flowiseai/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: flowise
      POSTGRES_USER: flowiseuser
      POSTGRES_PASSWORD: flowisepass
    restart: on-failure:5

  flowise:
    image: flowiseai/flowise:latest
    command: /bin/sh -c "sleep 3; flowise start"
    container_name: FlowiseAI
    hostname: flowise
    mem_limit: 4g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: wget --no-verbose --tries=1 --spider http://localhost:3000
    ports:
      - 8459:3000
    volumes:
      - /volume1/docker/flowiseai/data:/root/.flowise:rw
    environment:
      DEBUG: false
      PORT: 3000
      FLOWISE_USERNAME: marius
      FLOWISE_PASSWORD: mariushosting
      DATABASE_PATH: /root/.flowise
      APIKEY_PATH: /root/.flowise
      SECRETKEY_PATH: /root/.flowise
      LOG_LEVEL: info
      LOG_PATH: /root/.flowise/logs
      DATABASE_TYPE: postgres
      DATABASE_PORT: 5432
      DATABASE_HOST: flowise-db
      DATABASE_NAME: flowise
      DATABASE_USER: flowiseuser
      DATABASE_PASSWORD: flowisepass
    restart: on-failure:5
    depends_on:
      db:
        condition: service_healthy

Note: Before you paste the code above in the Web editor area below, change the value for FLOWISE_USERNAME. Type in your own username. marius is an example for a username.
Note: Before you paste the code above in the Web editor area below, change the value for FLOWISE_PASSWORD. Type in your own password. mariushosting is an example for a password.

FlowiseAI Synology NAS Set up 8

  • STEP 14

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.

FlowiseAI Synology NAS Set up 9

⌛Now just wait because the FlowiseAI image is about 3GB.

  • STEP 15

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

FlowiseAI Synology NAS Set up 10

  • STEP 16

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

  • STEP 17

Now open your browser and type in your HTTPS/SSL certificate like this https://flowiseai.yourname.synology.me In my case it’s https://flowiseai.mariushosting.synology.me If everything goes right, you will see the Healthchecks login page. Type in your own FLOWISE_USERNAME and FLOWISE_PASSWORD that you have previously added at STEP 13. Follow the instructions in the image below.

FlowiseAI Synology NAS Set up 11

  • STEP 18

At the top right of the page you can switch FlowiseAI to Dark Mode. Follow the instructions in the image below.

FlowiseAI Synology NAS Set up 12

  • STEP 19

Your FlowiseAI dashboard at a glance!

FlowiseAI Synology NAS Set up 13

Enjoy FlowiseAI!

🆘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 FlowiseAI 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 Container

This post was updated on Sunday / May 26th, 2024 at 9:08 PM