How to Install Shaarli on Your Synology NAS

by

How to Install Shaarli on Your Synology NAS

Shaarli is a minimalist link sharing service that you can install on your own server. It is designed to be personal (single-user), fast and handy. Shaarli allows you to bookmark your favorite pages, and share them with others or store them privately. You can add a description to your bookmarks, tag them etc. In this step by step guide I will show you how to install Shaarli on your Synology NAS using Docker.

💡Note: This guide works perfectly with the latest Shaarli v0.13.0 release.

💡Note: Check out my new guide on how to Install Shaarli 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 shaarli. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Shaarli Synology NAS Set up 1 new 2024

  • STEP 4

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

Shaarli Synology NAS Set up 2 new 2024

  • STEP 5

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

Synology User Defined Script

  • STEP 6

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 Shaarli. 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=shaarli \
-p 5377:80 \
-e PUID=1026 \
-e PGID=100 \
-e TZ=Europe/Bucharest \
-v /volume1/docker/shaarli/cache:/var/www/shaarli/cache \
-v /volume1/docker/shaarli/data:/var/www/shaarli/data \
--restart always \
ghcr.io/shaarli/shaarli:latest

Note: Before you paste the code above in the Run command area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.)
Note: Before you paste the code above in the Run command area below, change the value for TZ. (Select your current Time Zone from this list.)

Shaarli Synology NAS Set up 3 new 2024

  • STEP 7

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

Shaarli Synology NAS Set up 4 new 2024

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 8

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

Shaarli Synology NAS Set up 5 new 2024

  • STEP 9

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

  • STEP 10

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:5377 Create a Username and a Password and then a Title. Click Install. Follow the instructions in the image below.

Shaarli Synology NAS Set up 6

  • STEP 11

Login with your own Username and Password that you have previously created at STEP 10. Follow the instructions in the image below.

Shaarli Synology NAS Set up 7

Enjoy your self hosted Shaarli!

Shaarli Synology NAS Set up 8

🆘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 Shaarli container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Shaarli 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 Shaarli 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 Monday / July 22nd, 2024 at 7:30 PM

🧡 I Need Your Help!