RwMarkable is a lightweight, self-hosted web application for managing checklists and notes, designed as a simple alternative to complex, cloud-based to-do apps. Built with Next.js 14 and TypeScript, it features a clean interface for creating task lists with drag-and-drop reordering, progress bars, and categories, alongside a TipTap-powered WYSIWYG editor with Markdown support for rich text documents. It supports customizable themes and emojis through configuration files, simple sharing of checklists and documents among users on the same instance, and an admin panel for user management. In this step by step guide I will show you how to install rwMarkable on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest rwMarkable v1.0.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 rwmarkable. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

STEP 4

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

STEP 5

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

STEP 6

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.

STEP 7

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

STEP 8

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

STEP 9

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

STEP 10

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 11

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

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

services:
  rwmarkable:
    image: ghcr.io/fccview/rwmarkable:main
    container_name: rwMarkable
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 3000 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    ports:
      - 3666:3000
    volumes:
      - /volume1/docker/rwmarkable/data:/app/data:rw
      - /volume1/docker/rwmarkable/config:/app/config:ro
    environment:
       NODE_ENV: production
       HTTPS: false #or true if you use synology.me DDNS
    restart: on-failure:5

STEP 12

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 13

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

STEP 14

Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guides forget to support my work, or just ignore STEP 1. I’ve been very honest about this aspect of my work since the beginning: I don’t run any ADS, I don’t require subscriptions, paid or otherwise, I don’t collect IPs, emails, and I don’t have any referral links from Amazon or other merchants. I also don’t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. It’s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

STEP 15

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:3666 Type in your own Username and Password. Click Create Admin Account. Follow the instructions in the image below.

STEP 16

Create your first Document. On the left sidebar, click Documents. Type in the document Title and add a Category. Click Create Document. Follow the instructions in the image below.

STEP 17

Select, then edit your document that you have previously created at STEP 16. Follow the instructions in the image below.

STEP 18

Add some text in your document, then Save it. Follow the instructions in the image below.

STEP 19

On the bottom left, click the Settings icon, then change your Theme color. Follow the instructions in the image below.

STEP 20

Your rwMarkable dashboard at a glance!

Enjoy rwMarkable!

🆘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 rwMarkable container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make rwMarkable work via HTTPS, it’s mandatory to activate WebSocket. At STEP 11, remember to change the following environment variable from HTTPS: false to HTTPS: true

This post was updated on Tuesday / August 12th, 2025 at 10:08 AM

How to Install rwMarkable on Your Synology NAS

💡Note: This guide works perfectly with the latest rwMarkable v1.0.0 release.

STEP 1

STEP 2

STEP 3

STEP 4

STEP 5

STEP 6

STEP 7

STEP 8

STEP 9

STEP 10

STEP 11

STEP 12

STEP 13

STEP 14

STEP 15

STEP 16

STEP 17

STEP 18

STEP 19

STEP 20

🆘TROUBLESHOOTING

🧡 I Need Your Help!