How to Install Affine on Your Synology NAS

How to Install AFFiNE on Your Synology NAS

AFFiNE is a next-gen knowledge base that brings planning, sorting, and creating all together. Form your knowledge console at your wish. Open-source, privacy-first, and always free. AFFiNE is an alternative to Notion and Miro. It’s a workspace with fully merged docs, whiteboards and databases. In this step by step guide I will show you how to install AFFiNe on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest AFFiNe v0.14.6 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.

AFFiNE Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3010

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

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

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

AFFiNE Synology NAS Set up 6

  • STEP 11

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

AFFiNE 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 affine. Follow the instructions in the image below.

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

version: '3.9'
services:
  affine:
    image: ghcr.io/toeverything/affine-graphql:stable
    container_name: AFFINE
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/3010' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    command:
      ['sh', '-c', 'node ./scripts/self-host-predeploy && node ./dist/index.js']
    ports:
      - 3010:3010
      - 5555:5555
    depends_on:
      redis:
        condition: service_healthy
      postgres:
        condition: service_healthy
    volumes:
      - /volume1/docker/affine/config:/root/.affine/config:rw
      - /volume1/docker/affine/storage:/root/.affine/storage:rw
    logging:
      driver: 'json-file'
      options:
        max-size: '1000m'
    restart: on-failure:5
    environment:
      - NODE_OPTIONS="--import=./scripts/register.js"
      - AFFINE_CONFIG_PATH=/root/.affine/config
      - REDIS_SERVER_HOST=redis
      - DATABASE_URL=postgres://affineuser:affinepass@postgres:5432/affine?sslmode=disable
      - NODE_ENV=production
      - AFFINE_ADMIN_EMAIL=yourown@email
      - AFFINE_ADMIN_PASSWORD=mariushosting
  redis:
    image: redis:latest
    container_name: AFFINE-REDIS
    restart: on-failure:5
    volumes:
      - /volume1/docker/affine/redis:/data:rw
    healthcheck:
      test: ['CMD', 'redis-cli', '--raw', 'incr', 'ping']
      interval: 10s
      timeout: 5s
      retries: 5
  postgres:
    image: postgres:16
    container_name: AFFINE-DB
    restart: on-failure:5
    volumes:
      - /volume1/docker/affine/db:/var/lib/postgresql/data:rw
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "affine", "-U", "affinesuser"]
      interval: 10s
      timeout: 5s
      retries: 5
    environment:
      POSTGRES_USER: affineuser
      POSTGRES_PASSWORD: affinepass
      POSTGRES_DB: affine
      PGDATA: /var/lib/postgresql/data/pgdata

Note: Before you paste the code above in the Web editor area below, change the value for AFFINE_ADMIN_EMAIL and type in your own email address. You will need this email later at STEP 20.
Note: Before you paste the code above in the Web editor area below, change the value for AFFINE_ADMIN_PASSWORD and type in your own affine password. You will need this password later at STEP 21.

AFFiNE Synology NAS Set up 8

  • STEP 14

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.

AFFiNE Synology NAS Set up 9

  • STEP 15

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

AFFiNE 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://affine.yourname.synology.me In my case it’s https://affine.mariushosting.synology.me Click Got it. Follow the instructions in the image below.

AFFiNE Synology NAS Set up 15 new 2024

  • STEP 18

On the left sidebar, click Demo Workspace. Follow the instructions in the image below.

AFFiNE Synology NAS Set up 16

  • STEP 19

Click Sign up/ Sign in. Follow the instructions in the image below.

AFFiNE Synology NAS Set up 17

  • STEP 20

In the Email area, type in your own email address (AFFINE_ADMIN_EMAIL) that you have previously added at STEP 13. Click Continue with Email. Follow the instructions in the image below.

AFFiNE Synology NAS Set up 18

  • STEP 21

In the Password area, type in your own password (AFFINE_ADMIN_PASSWORD) that you have previously added at STEP 13. Click Sign in. Follow the instructions in the image below.

AFFiNE Synology NAS Set up 19

  • STEP 22

On the left sidebar, click Settings. Under Appearance, click Dark for the dark theme. Follow the instructions in the image below.

AFFiNE Synology NAS Set up 20

  • STEP 23

Click on the Demo Workspace, then change your workspace icon and name. Save the settings. Follow the instructions in the image below.

AFFiNE Synology NAS Set up 21

  • STEP 24

Your AFFiNE instance at a glance!

AFFiNE Synology NAS Set up 22

Enjoy Affine!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: If you want to run the Affine 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 AFFiNE 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 Monday / May 27th, 2024 at 7:55 PM