How to Install Activepieces on Your Synology NAS

How to Install Activepieces on Your Synology NAS

Activepieces is an open-source business automation tool alternative to Zapier, and fully self hosted. It’s built for no-code users and citizen developers. For example, you can build automations to receive email and Slack notifications about new contacts added to your HubSpot CRM. Activepieces allows you to automate almost anything without the need to code. In this step by step guide I will show you how to install Activepieces on your Synology NAS using Docker & Portainer.

Note: This guide works perfectly with the latest version of Activepieces 0.26.1

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

Activepieces Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTPS
Hostname: localhost
Port: 8310

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

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

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

Activepieces Synology NAS Set up 6

  • STEP 11

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

Activepieces Synology NAS Set up 7 new 2024

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

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

version: "3.9"
services:
  redis:
    image: redis
    container_name: Activepieces-REDIS
    hostname: activepieces-redis
    mem_limit: 256m
    mem_reservation: 50m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    read_only: true
    user: 1026:100
    healthcheck:
      test: ["CMD-SHELL", "redis-cli ping || exit 1"]
    volumes:
      - /volume1/docker/activepieces/redis:/data:rw
    environment:
      TZ: Europe/Bucharest
    restart: on-failure:5

  db:
    image: postgres:16
    container_name: Activepieces-DB
    hostname: activepieces-db
    mem_limit: 512m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "activepieces", "-U", "activepiecesuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/activepieces/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: activepieces
      POSTGRES_USER: activepiecesuser
      POSTGRES_PASSWORD: activepiecespass
    restart: on-failure:5

  activepieces:
    image: activepieces/activepieces:latest
    container_name: Activepieces
    hostname: activepieces
    mem_limit: 6g
    cpu_shares: 1024
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: timeout 20s bash -c ':> /dev/tcp/127.0.0.1/80' || exit 1
      interval: 10s
      timeout: 7s
      retries: 3
      start_period: 90s
    ports:
      - 8310:80
    volumes:
      - /volume1/docker/activepieces/cache:/usr/src/cache:rw
      - /volume1/docker/activepieces/packages:/usr/src/packages:rw
    environment:
    ## 256 bit encryption key, 32 hex character
      AP_ENCRYPTION_KEY: H9dpoP9ZPWq4F3g528ogLfxNVUorDB3s
    ## JWT Secret
      AP_JWT_SECRET: MariushostingMariushostingMari13
      AP_ENVIRONMENT: prod
      AP_FRONTEND_URL: https://activepieces.yourname.synology.me
      AP_ENGINE_EXECUTABLE_PATH: dist/packages/engine/main.js
      AP_NODE_EXECUTABLE_PATH: /usr/local/bin/node
      AP_EXECUTION_MODE: UNSANDBOXED
      AP_POSTGRES_DATABASE: activepieces
      AP_POSTGRES_HOST: activepieces-db
      AP_POSTGRES_PORT: 5432
      AP_POSTGRES_USERNAME: activepiecesuser
      AP_POSTGRES_PASSWORD: activepiecespass
      AP_REDIS_HOST: activepieces-redis
      AP_REDIS_PORT: 6379
      AP_SANDBOX_RUN_TIME_SECONDS: 600
      AP_TELEMETRY_ENABLED: false
      AP_SIGN_UP_ENABLED: false
    restart: on-failure:5
    depends_on:
      redis:
        condition: service_healthy
      db:
        condition: service_healthy

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.)
Note: Before you paste the code above in the Web editor area below, change the value for AP_JWT_SECRET and add your own JWT SECRET. MariushostingMariushostingMari13 is an example for a JWT SECRET. You should invent your own Value. Add 32 random characters, both letters and numbers.
Note: Before you paste the code above in the Web editor area below, change the value for AP_FRONTEND_URL and type in your own synology.me DDNS that you have previously created at STEP 6 with https:// at the beginning.

Activepieces Synology NAS Set up 8 new2 2024

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

Activepieces-Synology-NAS-Set-up-9-new3-2024

⌛Now just wait because the Activepieces image is about 3.8GB.

  • STEP 15

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

Activepieces 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://activepieces.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://activepieces.mariushosting.synology.me If everything goes right, you will see the Activepieces Login page. Type in your own credentials then click Sign up. Follow the instructions in the image below.

Activepieces Synology NAS Set up 11

  • STEP 18

Your Activepieces dashboard at a glance! Click +Build flow to start the magic!

Activepieces Synology NAS Set up 12 new 2024

Enjoy Activepieces!

🆘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 Activepieces 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 Tuesday / May 14th, 2024 at 4:03 PM