How to Install Obsidian on Your Synology NAS

by

How to Install Obsidian on Your Synology NAS

Obsidian is a personal knowledge base and note-taking software application that operates on Markdown files. It allows users to make internal links for notes and then to visualize the connections as a graph. It is designed to help users organize and structure their thoughts and knowledge in a flexible, non-linear way. In this step by step guide I will show you how to install Obsidian on your Synology NAS with Docker & Portainer.

💡Note: This guide works perfectly with the latest version of Obsidian v1.7.4

💡Note: Check out my new guide on how to Install Obsidian v1.7.4 with LinuxServer Image

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

Obsidian Synology Set up 1

  • STEP 4

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

Obsidian Synology Set up 2

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

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

version: "3.9"
services:
  obsidian:
    image: ghcr.io/sytone/obsidian-remote:latest
    container_name: Obsidian-Remote
    hostname: obsidian-remote
    mem_limit: 2g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: curl -f http://localhost:8080/ || exit 1
    ports:
      - 4501:8080
      - 27123:27123
      - 27124:27124
    volumes:
      - /volume1/docker/obsidian/vaults:/vaults:rw
      - /volume1/docker/obsidian/config:/config:rw
    environment:
      PUID: 1026
      PGID: 100
      TZ: Europe/Bucharest
      DOCKER_MODS: linuxserver/mods:universal-git
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.) 1026 is my personal PUID value and 100 is my personal PGID 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.)

Obsidian Synology Set up 3 new

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

Obsidian Synology Set up 4 new

⌛Now just wait because the Obsidian image is about 1.3GB.

  • STEP 8

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

Obsidian Synology Set up 5

  • 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:4501 Create a new vault, choose an existing vault or Markdown file or Open vault from Obsidian Sync. In the example below I chose to Create a new Vault. Follow the instructions in the image below.

Obsidian Synology Set up 6

  • STEP 11

If you choose to create a new Vault like me, click on the home icon select the vaults folder then click Open. Follow the instructions in the image below.

Obsidian Synology Set up 7

  • STEP 12

Give a name to the Vault then click Create. Follow the instructions in the image below.

Obsidian Synology Set up 8

  • STEP 13

Your Obsidian dashboard at a glance!

Obsidian Synology Set up 9

Enjoy Obsidian!

🆘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 Obsidian container over HTTPS, check out my guide on How to Run Docker Containers Over HTTPS. In order to make Obsidian work over https, it’s also mandatory to set up 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 Obsidian 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 / October 29th, 2024 at 12:30 PM

🧡 I Need Your Help!