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. On April 7, 2024, LinuxServer released a new Obsidian image in their repository. In this step by step guide I will show you how to install Obsidian using LinuxServer Image on your Synology NAS using Docker & Portainer.

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

💡Note: Check out my previous Obsidian v1.7.4 guide with the official Obsidian 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.

• STEP 4

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.

• STEP 5

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:
    container_name: Obsidian
    image: ghcr.io/linuxserver/obsidian:latest
    security_opt:
      - no-new-privileges:false
      - seccomp:unconfined
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/3000' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    environment:
     CUSTOM_USER: marius
     PASSWORD: mariushosting
     TZ: Europe/Bucharest
     PUID: 1026
     PGID: 100
    volumes:
      - /volume1/docker/obsidian:/config:rw
    ports:
      - 3421:3000
    shm_size: "5gb"
    restart: on-failure:5

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

• STEP 6

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.

• STEP 7

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

• STEP 8

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

• STEP 9

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:3421 If everything goes right, you will see the Obsidian Login page. Type in your own CUSTOM_USER and PASSWORD that you have previously created at STEP 5 then click Sign In. Follow the instructions in the image below.

• STEP 10

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.

• STEP 11

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

• STEP 12

On the left sidebar, click Other Locations, then the little home icon. Select the config folder, then click Open. Follow the instructions in the image below.

• STEP 13

Click Open. Follow the instructions in the image below.

• STEP 14

Click Create. Follow the instructions in the image below.

• STEP 15

Your Obsidian dashboard at a glance!

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 How to Run Docker Containers Over HTTPS. In order to make Obsidian 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 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