How to Install Flatnotes on Your Synology NAS

by

How to Install Flatnotes on Your Synology NAS

Flatnotes is designed to be a distraction free note taking app that puts your note content first. This means: a clean and simple user interface. No folders, notebooks or anything like that. Just all of your notes backed by powerful search and tagging functionality. You will have quick access to a full text search from anywhere in the app (keyboard shortcut “/”). In this step by step guide I will show you how to install Flatnotes on your Synology NAS using Docker & Portainer.

Note: This guide works perfectly with the latest version of Flatnotes v4.0.2

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

Flatnotes Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8053

Flatnotes Synology NAS Set up 3

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

Flatnotes Synology NAS Set up 4

  • STEP 9

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

Flatnotes Synology NAS Set up 5

  • STEP 10

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

Flatnotes Synology NAS Set up 6

  • STEP 11

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

Flatnotes Synology NAS Set up 7

  • STEP 12

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.

Flatnotes Synology NAS Set up 8

  • STEP 13

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

Flatnotes Synology NAS Set up 9

  • STEP 14

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

Flatnotes Synology NAS Set up 10

  • STEP 15

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

Flatnotes Synology NAS Set up 11

  • STEP 16

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 17

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

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

version: "3.9"
services:
  flatnotes:
    container_name: Flatnotes
    image: dullage/flatnotes:latest
    environment:
      FLATNOTES_AUTH_TYPE: password
      FLATNOTES_USERNAME: marius
      FLATNOTES_PASSWORD: mariushosting
      FLATNOTES_SECRET_KEY: MariushostingMariushostingMari13
    volumes:
      - /volume1/docker/flatnotes:/data
    ports:
      - 8053:8080
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for FLATNOTES_USERNAME. 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 FLATNOTES_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 FLATNOTES_SECRET_KEY and add your own SECRET KEY. MariushostingMariushostingMari13 is an example for a SECRET KEY. You should invent your own Value. Add 32 random characters, both letters and numbers.

Flatnotes Synology NAS Set up 12 new 2024

  • STEP 18

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.

Flatnotes Synology NAS Set up 13 new 2024

  • STEP 19

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

Flatnotes Synology NAS Set up 14

  • STEP 20

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

  • STEP 21

Now open your browser and type in your HTTPS/SSL certificate like this https://flatnotes.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://flatnotes.mariushosting.synology.me If everything goes right, you will see the Flatnotes Login page. Type in your own FLATNOTES_USERNAME and FLATNOTES_PASSWORD that you have previously created at STEP 17 then click Log In. Follow the instructions in the image below.

Flatnotes Synology NAS Set up 15

  • STEP 22

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

Flatnotes Synology NAS Set up 16

  • STEP 23

Choose between Markdown and WYSIWYG. Follow the instructions in the image below.

Flatnotes Synology NAS Set up 17

Enjoy Flatnotes!

🆘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 Flatnotes 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 Saturday / February 24th, 2024 at 5:50 PM

🧡 I Need Your Help!