How to Install Yal on Your Synology NAS

by

How to Install Yal on Your Synology NAS

Yet Another Landing page, aka Yal, is a simple link hub to display and search links. Yal allows easy branding, runs with the least privileges and is simple to use. In this step by step guide I will show you how to install YalĀ on yourĀ Synology NASĀ using Docker and Portainer.

šŸ’”Note: This guide works perfectly with the latest Yal v2.1.1Ā release.

  • 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

InstallĀ Text EditorĀ via Synology ā€œPackage Centerā€.Ā If you already have Text Editor installed on your Synology NAS, skip this STEP.

Synology Install Text Editor 2023

  • STEP 4

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

Yal Synology NAS Set up 1

  • STEP 5

Now create three new folders inside the yalĀ folder that you created at STEP 4 and name them config, icons, images. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Yal Synology NAS Set up 2

  • STEP 6

Download (click on the blue link below) then unzip and upload the items.json and searchEngines.json files below in the config folder that you have previously created at STEP 5. 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!

šŸ‘‰šŸ»Download json files.zip

Yal Synology NAS Set up 3

  • STEP 7

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 8

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

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

version: "3.9"
services:
  yal:
    image: timoreymann/yal:latest
    container_name: YAL
    restart: on-failure:5
    security_opt:
      - no-new-privileges:true
    ports:
      - 2024:2024
    volumes:
      - /volume1/docker/yal/config:/app/config:rw
      - /volume1/docker/yal/icons:/app/icons:rw
      - /volume1/docker/yal/images:/app/images:rw
    environment:
      YAL_PORT: 2024
      YAL_PAGE_TITLE: mariushosting
      YAL_CONFIG_FOLDER: /app/config
      YAL_IMAGES_FOLDER: /app/images
      YAL_MASCOT: Your Mascot Image Link
      YAL_LOGO: Your own Logo Image Link
      YAL_BACKGROUND: Your own Background Image Link
      YAL_FAVICON: Your own Favicon Image Link

Note: Before you paste the code above in the Web editor area below, change the value for YAL_PAGE_TITLE. Type in your own page title. mariushosting is an example for a page title.
Note: Before you paste the code above in the Web editor area below, change the value for YAL_MASCOT. Type in your own Mascot image link.
Note: Before you paste the code above in the Web editor area below, change the value for YAL_LOGO. Type in your own Logo image link.
Note: Before you paste the code above in the Web editor area below, change the value for YAL_BACKGROUND. Type in your own Background image link.
Note: Before you paste the code above in the Web editor area below, change the value for YAL_FAVICON. Type in your own Favicon image link.

Yal Synology NAS Set up 4

  • STEP 9

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.

Yal Synology NAS Set up 5

  • STEP 10

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

Yal Synology NAS Set up 6

  • STEP 11

Go back toĀ STEP 1Ā or you will deal with karma šŸ™‚

  • STEP 12

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:2024Ā Follow the instructions in the image below.

Yal Synology NAS Set up 7

  • STEP 13

To personalize YAL titles, text, icons, links, descriptions, modify the items.json file in the config folder, then save the file. To apply the settings, restart the YAL container. Follow the instructions in the image below.

Yal Synology NAS Set up 8

Enjoy Yal!

šŸ†˜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 Yal container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Yal 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 Yal 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 Wednesday / May 1st, 2024 at 5:36 PM

šŸ§” I Need Your Help!