How to Install Let’s Markdown on Your Synology NAS

How to Install Lets Markdown on Your Synology NAS

Fast, minimal web editor that makes markdown editing collaborative and accessible to everyone. Let’s Markdown is a self hosted markdown editor. In this step by step guide I will show you how to install Let’s Markdown on your Synology NAS using Docker.

Top Let’s Markdown features:

  • Live collaborative markdown editing and preview.
  • VSCode-like editor with support for command palette (syntax highlighting, autocomplete, editor themes).
  • Minimal setup with no login required – say goodbye to malicious trackers and privacy invasions.
  • Efficient backend built with Rust and WebAssembly.
  • Dark and light mode.
  • Emoji support with shortcuts enabled.
  • Upcoming features: cursors tracking, synced scrolling, subscript/footnote/insert support, and more.
  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Container Manager via Synology “Package Center”. If you run an older DSM version (under 7.2), search for Docker instead of Container Manager.

Download Container Manager Synology Docker

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

Letsmarkdown Synology NAS Set up 1

  • STEP 5

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

Letsmarkdown 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 Let’s Markdown!. After that, add the following instructions:

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3030

Letsmarkdown Synology NAS Set up 3 new

  • 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 / Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

Letsmarkdown Synology NAS Set up 5

  • STEP 9

Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script. Follow the instructions in the image below.

Synology User Defined Script

  • STEP 10

Once you click on User-defined script, a new window will open. Follow the instructions below:

  1. General: In the Task field type in Install Letsmarkdown. Uncheck the “Enabled” option. Select root User.
  2. Schedule: Select Run on the following date then select “Do not repeat“.
  3. Task Settings: Check “Send run details by email“, add your email then copy paste the code below in the Run command area. After that, click OK.
docker run -d --name=letsmarkdown \
-p 3030:3030 \
--restart always \
cveinnt/letsmarkdown

Letsmarkdown Synology NAS Set up 7 new 2023

  • STEP 11

After you click OK on STEP 10 a new warning pop up window will open. Click OK.

Letsmarkdown Synology NAS Set up 8

After you click OK, type in your DSM Password then click Submit. Follow the instructions in the image below.

Synology Task Scheduler Confirm Admin Password

  • STEP 12

After you click Submit on STEP 11, select your “Install Letsmarkdown” Task then click the “Run” tab. You will be asked to run Install Letsmarkdown – click OK. Follow the instructions in the image below.

Letsmarkdown Synology NAS Set up 9

  • STEP 13

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

  • STEP 14

Now open your browser and type in your HTTPS/SSL certificate like this https://letsmarkdown.yourname.synology.me In my case it’s https://letsmarkdown.mariushosting.synology.me you can easily switch to Dark Mode and share your letsmarkdown link with your friends.

Letsmarkdown Synology NAS Set up 10

Enjoy Let’s Markdown!

🆘TROUBLESHOOTING

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

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 Let’s Markdown 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 Friday / August 23rd, 2024 at 5:57 PM