Calibre

Calibre

  • You can support more guides like this Click to Donate
  • Version
  • Create Date February 2, 2024
  • Last Updated February 2, 2024
  • Download
  • File Count 0
  • Installation Support Ask Support

Open source home automation

In this tutorial i will show you how to install Calibre and Calibre-web using Portainer

Calibre is a powerful and easy to use e-book manager. Users say it's outstanding and a must-have. It'll allow you to do nearly everything and it takes things a step beyond normal e-book software. It's also completely free and open source and great for both casual users and computer experts.

Calibre-web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database. It is also possible to integrate google drive and edit metadata and your calibre library through the app itself.

If you don't have the Docker Engine and Portainer apps installed on your NAS, install them using this guide Docker Engine and Portainer. If you have them already installed, proceed further.

If you already have them from a previous container installation, proceed to Step 3. If not, follow this guide to launch a web terminal and rund the command :

id

You can also use putty or any other SSH client. In this case, ssh service must run on your NAS

Find your current time zone on this website, as example for Brussels is:

TZ=Europe/Brussels

Open Portainer using the icon from TOS desktop ( if Portainer is already installed and enabled), or enable Portainer from App Center and open it from there by typing in your web browser http://yournasip:19000.

Note. If you open the Portainer via the TOS desktop icon, you can face an error message during deployments of big images. If you want to access portainer only for Stack update (without repulling the image) then you can do it via the TOS desktop icon.

After you login on Portainer, go to Home, then click on your Local Environment

Go to Stacks and click on Add stack

On the name type calibre, select Web editor and paste the code below.

Make sure you replace the PUID and PGID with the values for your user found on Step 2
Make sure you replace the TZ value with the value for your specific zone found on Step 3
Replace the default PASSWORD and CUSTOM_USER for calibre (default is terra)

Config files for calibre will be stored at /Volume1/DockerAppsData/Calibre
Config files for calibre-web will be stored at /Volume1/DockerAppsData/Calibre-web
Library data will be stored at /Volume1/DockerAppsData/Calibre/Calibre Library

restart: you can choose from always, unless-stopped, or on-failure[:number of retries]

- DOCKER_MODS=linuxserver/mods:universal-calibre is only for x86_64 platforms

version: "3.9"
services:
  calibre:
    image: lscr.io/linuxserver/calibre:latest
    container_name: calibre
    security_opt:
      - no-new-privileges:true
      - seccomp:unconfined
    environment:
      - PUID=0
      - PGID=0
      - TZ=Europe/Brussels
      - PASSWORD=terra
      - CUSTOM_USER=terra
    volumes:
      - /Volume1/DockerAppsData/Calibre:/config
    ports:
      - 8012:8080
      - 8112:8181
      - 8013:8081
    restart: on-failure:5

  calibre-web:
    image: lscr.io/linuxserver/calibre-web:latest
    container_name: calibre-web
    environment:
      - PUID=0
      - PGID=0
      - TZ=Europe/Brussels
      - DOCKER_MODS=linuxserver/mods:universal-calibre
      - OAUTHLIB_RELAX_TOKEN_SCOPE=1
    volumes:
      - /Volume1/DockerAppsData/Calibre-web:/config
      - /Volume1/DockerAppsData/Calibre/Calibre Library:/books
    ports:
      - 8014:8083
    restart: on-failure:5

After you adapt the needed values, scroll down and click on Deploy the stack. The button will change to Deployment in progress.

If no errors occur, you will get a message that deployment was successful and the calibre stack will appear on the list. Click on it.

If everything was OK, the container will show as running.

Navigate to http://yournasip:8012 to open the calibre interface or click on the published ports

Go through the steps and click on Finish

Now open the calibre-web by typing in your browser http://yournasip:8014 The default user:password are admin:admin123

Location of the database will be /books. Click on Save

Once the path is saved, you can go to books and enjoy calibre

Scroll to Top