How to Install TiddlyWiki on Your Synology NAS

How to Install TiddlyWiki on Your Synology NAS

TiddlyWiki is a personal wiki and a non-linear notebook for organizing and sharing complex information. It is an open-source single page application wiki in the form of a single HTML file that includes CSS, JavaScript, and the content. It is designed to be easy to customize and re-shape depending on application. In this step by step guide I will show you how to install TiddlyWiki on your Synology NAS using Docker.

💡Note: This guide works perfectly with the latest version of TiddlyWiki v.5.2.7

💡Note: Check out my new guide on how to Install TiddlyWiki Using Portainer.

  • 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

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

TiddlyWiki Synology NAS Set up 1 new 2024

  • STEP 4

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

Synology User Defined Script

  • STEP 5

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 TiddlyWiki. 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=tiddlywiki \
-p 5645:8080 \
-e USERNAME=marius \
-e PASSWORD=mariushosting \
-v /volume1/docker/tiddlywiki:/var/lib/tiddlywiki \
--restart always \
m0wer/tiddlywiki

Note: Before you paste the code above in the Run command area, change the value for USERNAME and add your own username. marius is an example for a username. You have to insert your own username.
Note: Before you paste the code above in the Run command area, change the value for PASSWORD and add your own password. mariushosting is an example for a password. You have to insert your own password.

TiddlyWiki Synology NAS Set up 3 3new 2023

  • STEP 6

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

TiddlyWiki Synology NAS Set up 4 4new 2023

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 7

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

TiddlyWiki Synology NAS Set up 5 new 2024

  • 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:5645 Add your own Username and Password you have previously added at STEP 5. Click Sign In. Follow the instructions in the image below.

TiddlyWiki Synology NAS Set up 6 new 2024

  • STEP 10

You can start adding your first post. Follow the instructions in the image below.

TiddlyWiki Synology NAS Set up 7 new 2024

  • STEP 11

After adding your first post, save it. Follow the instructions in the image below.

TiddlyWiki Synology NAS Set up 8 new 2024

  • STEP 12

You can change your current TiddlyWiki theme by clicking the little gear icon at the top of the page. Click “Palette“. Follow the instructions in the image below.

TiddlyWiki Synology NAS Set up 9

  • STEP 13

Your new TiddlyWiki skin at a glance!

TiddlyWiki Synology NAS Set up 10

Enjoy TiddlyWiki!

🆘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 TiddlyWiki container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make TiddlyWiki 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 TiddlyWiki 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 / May 14th, 2024 at 11:31 PM