Portainer Templates logo

Portainer Templates

Calibre Calibre

Books

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.

Image details

Pulls: 51.1M
Architectures: amd64, arm64
Image size: 1.2 GB
Latest: 9.11.0
User: linuxserver
Created: May 20, 2019
Updated: 5 days ago
Status: active

Configuration

Type
Container
Platform
linux
Image
linuxserver/calibre:latest
Ports
8080:8080/tcp8181:8181/tcp8081:8081/tcp
Volumes
/config : /srv/lsio/calibre/config
Env vars
PUID=1000PGID=1000TZ=Etc/UTCPASSWORD=CLI_ARGS=
Restart
unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/calibre/config

Installation

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

docker run -d --name Calibre \
  -p 8080:8080/tcp \
  -p 8181:8181/tcp \
  -p 8081:8081/tcp \
  -e 'PUID=1000' \
  -e 'PGID=1000' \
  -e 'TZ=Etc/UTC' \
  -e 'PASSWORD=' \
  -e 'CLI_ARGS=' \
  -v /srv/lsio/calibre/config:/config \
  --restart=unless-stopped \
  linuxserver/calibre:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  calibre:
    image: linuxserver/calibre:latest
    ports:
      - 8080:8080/tcp
      - 8181:8181/tcp
      - 8081:8081/tcp
    volumes:
      - /srv/lsio/calibre/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      PASSWORD: ''
      CLI_ARGS: ''
    restart: unless-stopped

Save this file as calibre-stack.yml, then from a manager node, run docker stack deploy -c calibre-stack.yml calibre

version: '3.8'
services:
  calibre:
    image: linuxserver/calibre:latest
    ports:
      - 8080:8080/tcp
      - 8181:8181/tcp
      - 8081:8081/tcp
    volumes:
      - /srv/lsio/calibre/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      PASSWORD: ''
      CLI_ARGS: ''
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

calibre-deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: calibre
  labels:
    app: calibre
spec:
  replicas: 1
  selector:
    matchLabels:
      app: calibre
  template:
    metadata:
      labels:
        app: calibre
    spec:
      containers:
        - name: calibre
          image: linuxserver/calibre:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
            - name: PASSWORD
              value: ''
            - name: CLI_ARGS
              value: ''
          ports:
            - containerPort: 8080
              protocol: TCP
            - containerPort: 8181
              protocol: TCP
            - containerPort: 8081
              protocol: TCP
          volumeMounts:
            - name: calibre-data-0
              mountPath: /config
      volumes:
        - name: calibre-data-0
          hostPath:
            path: /srv/lsio/calibre/config

calibre-service.yaml

apiVersion: v1
kind: Service
metadata:
  name: calibre
spec:
  type: LoadBalancer
  selector:
    app: calibre
  ports:
    - name: 8080-tcp
      port: 8080
      targetPort: 8080
      protocol: TCP
    - name: 8181-tcp
      port: 8181
      targetPort: 8181
      protocol: TCP
    - name: 8081-tcp
      port: 8081
      targetPort: 8081
      protocol: TCP

Save this file as ~/.config/containers/systemd/calibre.container

[Unit]
Description=Calibre

[Container]
Image=linuxserver/calibre:latest
ContainerName=calibre
PublishPort=8080:8080/tcp
PublishPort=8181:8181/tcp
PublishPort=8081:8081/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Environment=PASSWORD=
Environment=CLI_ARGS=
Volume=/srv/lsio/calibre/config:/config

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start calibre

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

linuxserver/calibre

This readme has been truncated from the full version found HERE

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.

Application Setup

The application can be accessed at:
  • https://yourhost:8181/

In the wizard, make sure to select the default library location /config/Calibre Library as the path for books. We will not provide support if you use a different path.
Calibre's built-in webserver is not enabled by default. If you wish to use it, please enable it in Calibre Preferences under Sharing over the net. Make sure to leave the port setting as 8081 and check the box to start it automatically.

Usage

docker run -d \
  --name=calibre \
  --security-opt seccomp=unconfined `#optional` \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e PASSWORD= `#optional` \
  -e CLI_ARGS= `#optional` \
  -p 8080:8080 \
  -p 8181:8181 \
  -p 8081:8081 \
  -v /path/to/calibre/config:/config \
  --shm-size="1gb" \
  --restart unless-stopped \
  lscr.io/linuxserver/calibre:latest

Serve Calibre on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying calibre.example.com to http://Calibre:8080

Add this to your Caddyfile

calibre.example.com {
	reverse_proxy http://Calibre:8080
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs Calibre
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8080 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8080
  • Stop the other service, or pick a different host port. In 8080:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8080. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Calibre can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8080

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/calibre/config
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/calibre:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect Calibre --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

PASSWORD, CLI_ARGS have no default value, and Calibre may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Similar apps

Booksonic Booksonic BooksCalibre Web Calibre Web BooksCops Cops Booksgazee gazee BooksKavita Kavita BooksKomga Komga BooksLazylibrarian Lazylibrarian BooksMylar Mylar Books