How to Install SiYuan on Your Synology NAS

How to Install SiYuan on Your Synology NAS

SiYuan is an open-source, privacy-first, personal knowledge management system, support fine-grained block-level reference and Markdown WYSIWYG. In this step by step guide I will show you how to install SiYuan on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest SiYuan v3.1.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

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

SiYuan Synology NAS Set up 1

  • STEP 4

Right click on the siyuan folder that you have previously created at STEP 3 then click Properties. Follow the instructions in the image below.

SiYuan Synology NAS Set up 2

  • STEP 5

Go to the Permission tab then click Advanced options. From the drop-down menu choose “Make inherited permissions explicit“. Follow the instructions in the image below.

SiYuan Synology NAS Set up 3

  • STEP 6

Select Everyone then click the Edit tab. Follow the instructions in the image below.

SiYuan Synology NAS Set up 3

  • STEP 7

Check all Read and Write Permissions. Click Done. Follow the instructions in the image below.

SiYuan Synology NAS Set up 5

  • STEP 8

After you click Done on STEP 7, check “Apply to this folder, sub-folders and files“. Click Save. Follow the instructions in the image below.

SiYuan Synology NAS Set up 6

  • STEP 9

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 10

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

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

version: "3.9"
services:
  siyuan:
    image: b3log/siyuan
    container_name: SiYuan
    command: ['--workspace=/siyuan/workspace/', '--accessAuthCode=marius']
    security_opt:
      - no-new-privileges:true
    ports:
      - 6806:6806
    volumes:
      - /volume1/docker/siyuan:/siyuan/workspace:rw
    restart: on-failure:5
    environment:
      - TZ=Europe/Bucharest

Note: Before you paste the code above in the Web editor area below, change the value for –accessAuthCode= Type in your own password. marius is an example for a password. You will need this password later at STEP 14.
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.)

SiYuan Synology NAS Set up 7

  • STEP 11

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.

SiYuan Synology NAS Set up 8

  • STEP 12

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

SiYuan Synology NAS Set up 9

  • STEP 13

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

  • STEP 14

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:6806 Type in your own password that you have previously added at STEP 10. Follow the instructions in the image below.

SiYuan Synology NAS Set up 10

  • STEP 15

Your SiYuan start page at a glance!

SiYuan Synology NAS Set up 11

  • STEP 16

Start adding your first document!

SiYuan Synology NAS Set up 12

Enjoy SiYuan!

🆘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 SiYuan container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make SiYuan work via HTTPS, it’s mandatory to activate WebSocket.

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 SiYuan 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 Thursday / July 11th, 2024 at 12:20 AM