How to Install Servas on Your Synology NAS

How to Install Servas on Your Synology NAS

Servas is a self-hosted bookmark management tool. It is based on Laravel and Inertia.js and uses Tailwind CSS and Svelte for the frontend. Servas allows you to categorize your bookmarks by groups and tags. In this step by step guide I will show you how to install Servas on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest version of Servas v0.2.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

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.

Servas Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8421

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

 

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

Servas 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 servas. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Servas Synology NAS Set up 6

  • STEP 11

Download (click on the blue link below) and upload the servas.db file below in the servas folder that you have previously created at STEP 10. Follow the instructions in the image below. 🔒Note: Support my work to unlock the password. You can use this password to download any file on mariushosting forever!

👉🏻servas.db

Servas Synology NAS Set up 7

  • STEP 12

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 13

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

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

services:
  servas:
    image: beromir/servas
    container_name: Servas
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 80 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    restart: on-failure:5
    ports:
      - 8421:80
    volumes:
      - /volume1/docker/servas/servas.db:/var/www/html/database/sqlite/servas.db
    environment:
     DB_CONNECTION: sqlite
     DB_DATABASE: /var/www/html/database/sqlite/servas.db
     DB_FOREIGN_KEYS: true
     APP_NAME: Servas
     APP_ENV: production
     APP_KEY: base64:Mk3oIhBicQx5NuTYpKcqNSRt4ANv+3nikg+z9yzWYrI=
     APP_DEBUG: false
     APP_URL: https://servas.yourname.synology.me

Note: Before you paste the code above in the Web editor area below, change the value for APP_KEY. (Generate your own free APP KEY.)
Note: Before you paste the code above in the Web editor area below, change the value for APP_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.

Servas Synology NAS Set up 8

  • STEP 14

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.

Servas Synology NAS Set up 9

  • STEP 15

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

Servas Synology NAS Set up 10

  • STEP 16

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

  • STEP 17

Now open your browser and type in your HTTPS/SSL certificate like this https://servas.yourname.synology.me/register In my case it’s https://servas.mariushosting.synology.me/register Type in your own details, then click Register. Follow the instructions in the image below.

Servas Synology NAS Set up 11

  • STEP 18

Click Add a new link to add your first favorite website. Follow the instructions in the image below.

Servas Synology NAS Set up 12

  • STEP 19

Type in the URL and the Title then click Create Link. Follow the instructions in the image below.

Servas Synology NAS Set up 13

  • STEP 20

Your Servas dashboard at a glance!

Servas Synology NAS Set up 14

Enjoy Servas!

🆘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 Servas container with the latest image.
NoteHow to Free Disk Space on Your NAS if You Run Docker.
NoteHow to Schedule Start & Stop For Docker Containers.
NoteHow to Activate Email Notifications.
NoteHow to Add Access Control Profile on Your NAS.
NoteHow to Change Docker Containers Restart Policy.
NoteHow to Use Docker Containers With VPN.
NoteConvert 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 / October 29th, 2024 at 9:33 PM