How to Install Xibo on Your Synology NAS

by

How to Install Xibo on Your Synology NAS

Xibo is an open source digital signage solution comprised of a web based content management system (CMS) and is the preferred platform for info screens on campus. It can display a wide range of media on various displays / screen sizes and can remotely schedule your content using a web portal. In this step by step guide I will show you how to install Xibo on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Xibo v4.0.14 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

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.

Xibo Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 65501

Xibo 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 / Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

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

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

Xibo Synology NAS Set up 6

  • STEP 11

Now create seven new folders inside the xibo folder that you have previously created at STEP 10 and name them backup, certs, custom, db, library, scripts, theme. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Xibo Synology NAS Set up 7

  • STEP 12

Download (click on the blue link below) and upload the my.cnf file below in the db folder that you have previously created at STEP 11. 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 my.cnf

Xibo Synology NAS Set up 8

  • STEP 13

Follow my step by step guide on how to activate SMTP for your Gmail account. This step is mandatory. Note: If you don’t want to use the easiest way for SMTP with Google and you already have SMTP details from your own Mail Server, you can just skip this STEP and use your personalized email SMTP details instead.

  • STEP 14

Log into Portainer using your username and password. In the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 15

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

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

services:
  db:
    image: mariadb:11.4-noble #LTS Long Time Support Until May 29, 2029.
    container_name: Xibo-DB
    hostname: xibo-db
    security_opt:
      - no-new-privileges:false
    volumes:
      - /volume1/docker/xibo/db:/var/lib/mysql:rw
      - /volume1/docker/xibo/db:/etc/mysql/conf.d:rw
    env_file:
      - stack.env
    environment:
      TZ: Europe/Bucharest
      MYSQL_ROOT_PASSWORD: xibopass
      MYSQL_ROOT_HOST: "0.0.0.0"
    restart: on-failure:5

  cms-memcached:
    image: memcached:latest
    command: memcached -m 15
    container_name: Xibo-CACHE
    hostname: xibo-cache
    mem_limit: 100m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    read_only: true
    user: 1026:100
    restart: on-failure:5

  xibo-xmr:
    image: ghcr.io/xibosignage/xibo-xmr:latest
    container_name: Xibo-XMR
    hostname: xibo-xmr
    mem_limit: 256m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    ports:
      - 65500:9505
    env_file:
      - stack.env
    restart: on-failure:5

  xibo-web:
    image: ghcr.io/xibosignage/xibo-cms:latest
    container_name: Xibo-WEB
    hostname: cms-web
    mem_limit: 1g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    ports:
      - 65501:80
    volumes:
      - /volume1/docker/xibo/custom:/var/www/cms/custom:rw
      - /volume1/docker/xibo/backup:/var/www/backup:rw
      - /volume1/docker/xibo/theme:/var/www/cms/web/theme/custom:rw
      - /volume1/docker/xibo/library:/var/www/cms/library:rw
      - /volume1/docker/xibo/scripts:/var/www/cms/web/userscripts:rw
      - /volume1/docker/xibo/certs:/var/www/cms/ca-certs/.*pem:rw
      - /volume1/docker/xibo/certs:/var/www/cms/ca-certs/.*crt:rw
    env_file:
      - stack.env
    environment:
      XMR_HOST: xibo-xmr
      CMS_USE_MEMCACHED: true
    restart: on-failure:5

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.)
Note: Before you paste the code above in the Web editor area below, change the value numbers for user with your own UID and GID values. (Follow my step by step guide on how to do this.) 1026 is my personal UID value and 100 is my personal GID value. You have to type in your own values.

Xibo Synology NAS Set up 9 new 2027

  • STEP 16

Click the Upload button after Web editor. Download the stack.env file by clicking the blue link below and then upload it from your computer in the “Load variables from .env files“. 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 stack.env file

Environment Variables Portainer Synology

  • STEP 17

Note: On the environment variables change the value for CMS_SERVER_NAME with your own synology.me DDNS without https:// at the beginning that you have previously created at STEP 6. 🟣
Note: On the Environment variables change the value for CMS_SMTP_FROM and add your own Gmail address. 🔴 STEP 13.
Note: On the Environment variables change the value for CMS_SMTP_USERNAME and add your own Gmail address. 🔴 STEP 13.
Note: On the Environment variables change the value for CMS_SMTP_PASSWORD and add your own Gmail App password. 🔵 STEP 13.

Xibo Synology NAS Set up 11

  • STEP 18

After you made the changes, click the Web editor button. Follow the instructions in the image below.

Xibo Synology NAS Set up 11 new 2027

  • STEP 19

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.

Xibo Synology NAS Set up 12 new 2027

  • STEP 20

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

Xibo Synology NAS Set up 14

  • STEP 21

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

  • STEP 22

Please wait approximately 3-5 minutes for the installation to be completed or you will get a blank Synology page if you try to connect too soon. Now open your browser and type in your HTTPS/SSL certificate like this https://xibo.yourname.synology.me In my case it’s https://xibo.mariushosting.synology.me If everything goes right, you will see the Xibo Login page. Type in the default Username and Password, then click Login.

⚠️Warning: the default email is xibo_admin and the default password is password

Xibo Synology NAS Set up 13 new 2027

  • STEP 23

Your Xibo dashboard at a glance! You can change the default password at the top right of the page by clicking on your profile icon, then Edit Profile. Follow the instructions in the image below.

Xibo Synology NAS Set up 14 new 2027

Enjoy Xibo!

🆘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 Xibo 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 Saturday / October 5th, 2024 at 5:35 PM

🧡 I Need Your Help!