How to Install Ubooquity on Your Synology NAS

How to Install Ubooquity on Your Synology NAS

Ubooquity is a free, lightweight and easy-to-use home server for your comics and ebooks library. Ubooquity supports many types of file formats, for example: ePUB, CBZ, CBR and PDF files. I use it as a replacement for Calibre and it works just great. In this step by step guide I will show you how to install Ubooquity on your Synology NAS using Docker.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Docker via Synology “Package Center”.

Install Docker Synology DSM 7

  • STEP 3

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

Ubooquity Synology NAS Set up 1

  • STEP 4

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

Ubooquity Synology NAS Set up 2

  • STEP 5

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 Ubooquity. 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=ubooquity \
-p 2202:2202 \
-p 2203:2203 \
-e PUID=1026 \
-e PGID=100 \
-e TZ=Europe/Bucharest \
-e MAXMEM=8192 \
-v /volume1/docker/ubooquity:/config \
-v /volume1/web/books:/books \
-v /volume1/web/comics:/comics \
-v /volume1/web/rawfiles:/files \
--restart always \
ghcr.io/linuxserver/ubooquity

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.)
Note: In the code above after -v /volume1/docker/ubooquity:/config \ you have to add your personal path to books. For example, I have used my personal books path folder -v /volume1/web/books:/books \ Change it according to your preferences. -v /path/toyour/books :/books  \ Do the same operation for the comics and the rawfiles folders. If you don’t have comics and rawfiles folders, and want to use ubooquity only for your books, just delete the comics and files lines in the code above. Only keep the books string of code.

Ubooquity Synology NAS Set up 3

  • STEP 6

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

Ubooquity Synology NAS Set up 4

  • STEP 7

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

Ubooquity Synology NAS Set up 5

  • STEP 8

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

  • STEP 9

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:2202/ubooquity Click on books. Follow the instructions in the image below.

Ubooquity Synology NAS Set up 6

  • STEP 10

Click books again. Follow the instructions in the image below.

Ubooquity Synology NAS Set up 7

  • STEP 11

Your ebooks are available. You can now read your favorite book!

Ubooquity Synology NAS Set up 8

Select one book from your list then click on it to start reading.

Ubooquity Synology NAS Set up 9

  • STEP 12

You can access the Ubooquity admin dashboard from a different address. Open your browser and type in http://Synology-ip-address:2203/ubooquity/admin Choose an administrator password, then click SUBMIT. Follow the instructions in the image below.

Ubooquity Synology NAS Set up 10

  • STEP 13

After you click SUBMIT on STEP 12, add the password you have previously created then click LOG IN. Follow the instructions in the image below.

Ubooquity Synology NAS Set up 11

  • STEP 14

Welcome to your Ubooquity admin dashboard!

Ubooquity Synology NAS Set up 12

You can set different parameters. For example, you can change the size of your book thumbnails. After you change the parameter at the top right of the page, click SAVE AND RESTART. Follow the instructions in the image below.

Ubooquity Synology NAS Set up 13

As you can see in the screenshot below, if you access your books address again, the thumbnails images are visibly larger.

Ubooquity Synology NAS Set up 14

Note: If you want to run the Ubooquity container over HTTPS, check out my guide on How to Run Docker Containers Over HTTPS.

Note: You can find the admin dashboard at this address http://Synology-ip-address:2203/ubooquity/admin and the web guy at this other address http://Synology-ip-address:2202/ubooquity Be careful not to confuse the two addresses.
Note: Can I run Docker on my Synology NAS? See the supported models.
Note: Find out how to update the Ubooquity 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.

This post was updated on Thursday / October 21st, 2021 at 8:46 PM