HedgeDoc is an open-source, web-based, self-hosted, collaborative markdown editor. You can use it to easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers and they’re ready to go. In this step by step guide I will show you how to install HedgeDoc on your Synology NAS using Docker and Portainer.

💡Note: This guide works perfectly with the latest HedgeDoc v1.9.9 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.

• STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 9600

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

• STEP 8

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

• STEP 9

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.

• STEP 10

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

• STEP 11

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

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

• STEP 13

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

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

version: "3.9"
services:
  db:
    image: mariadb:11.3-jammy
    container_name: HedgeDoc-DB
    hostname: hedgedoc-db
    security_opt:
      - no-new-privileges:true
    environment:
      - TZ=Europe/Bucharest
      - MYSQL_ROOT_PASSWORD=rootpass
      - MYSQL_DATABASE=hedgedoc
      - MYSQL_USER=hedgedocuser
      - MYSQL_PASSWORD=hedgedocpass
    volumes:
      - /volume1/docker/hedgedoc/db:/var/lib/mysql:rw
    restart: always

  hedgedoc:
    image: lscr.io/linuxserver/hedgedoc:latest
    container_name: HedgeDoc
    hostname: hedgedoc
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: wget --no-verbose --tries=1 --spider http://localhost:3000 || exit 1
    environment:
      - TZ=Europe/Bucharest
      - PUID=1026
      - PGID=100
      - DB_HOST=hedgedoc-db
      - DB_PORT=3306
      - DB_USER=hedgedocuser
      - DB_PASS=hedgedocpass
      - DB_NAME=hedgedoc
      - CMD_DOMAIN=hedgedoc.yourname.synology.me
      - CMD_URL_ADDPORT=false
      - CMD_PROTOCOL_USESSL=true
      - CMD_PORT=3000
      - CMD_ALLOW_ORIGIN=['localhost']
    volumes:
      - /volume1/docker/hedgedoc/appdata:/config
    ports:
      - 9600:3000
    restart: always
    depends_on:
      db:
        condition: service_started

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 CMD_DOMAIN and type in your own synology.me DDNS that you have previously created at STEP 6 without https:// at the beginning.

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

• STEP 15

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

• 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://hedgedoc.yourname.synology.me In my case it’s https://hedgedoc.mariushosting.synology.me If everything goes right, you will see the HedgeDoc main page. Click Sign in. Follow the instructions in the image below.

• STEP 18

After you click Sign in at STEP 17 a new pop up window will open. Type in your own email address and password then click Register.

• STEP 19

You will get a notification that your account is created. Click Sign in. Follow the instructions in the image below.

• STEP 20

Type in your own email address and password that you have previously created at STEP 18, then click Sign in. Follow the instructions in the image below.

• STEP 21

At the top right of the page click + New note. Follow the instructions in the image below.

Add your first note!

Enjoy HedgeDoc!

🆘TROUBLESHOOTING

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

Note: Find out how to update the HedgeDoc container with the latest image.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Can I run Docker on my Synology NAS? See the supported models.
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 Saturday / February 24th, 2024 at 5:48 AM