Synology: Install Shaarli With Portainer

Synology Install Shaarli With Portainer

My previous guide for Shaarli involved the use of Task Scheduler. Today I’m offering a recommended and excellent alternative for installing the latest Shaarli version via Portainer. 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 & Portainer.

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

  • 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 folders and name it shaarli. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Shaarli Synology NAS Portainer Set up 1

  • 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 Portainer Set up 2

  • STEP 5

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 6

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

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

version: "3.9"
services:
  shaarli:
    container_name: Shaarli
    image: ghcr.io/shaarli/shaarli:latest
    mem_limit: 2g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    restart: on-failure:5
    ports:
      - 5377:80
    volumes:
      - /volume1/docker/shaarli/cache:/var/www/shaarli/cache:rw
      - /volume1/docker/shaarli/data:/var/www/shaarli/data:rw
    environment:
      PUID: 1026
      PGID: 100
      TZ: Europe/Bucharest

Note: Before you paste the code above in the Web editor 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 Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)

Shaarli Synology NAS Portainer Set up 3

  • STEP 7

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.

Shaarli Synology NAS Portainer Set up 4

  • STEP 8

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

Shaarli Synology NAS Portainer Set up 5

  • 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 Portainer 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 Portainer Set up 7

  • STEP 12

Your Shaarli dashboard at a glance!

Shaarli Synology NAS Portainer Set up 8

Enjoy Shaarli!

🆘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: 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