Calibre-Web

Calibre-Web is a web app providing a clean interface for browsing, reading, and downloading eBooks using an existing or new Calibre database.

Version Tags

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

services:
  calibre-web:
    image: "ghcr.io/daemonless/calibre-web:latest"
    container_name: calibre-web
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      # - CALIBRE_ADMIN_USER=  # Admin username to update on startup when paired with CALIBRE_ADMIN_PASSWORD (default: admin)
      # - CALIBRE_ADMIN_PASSWORD=  # Admin password to set on startup
      # - CALIBRE_HOST=  # Address the web server listens on (default: 0.0.0.0)
      # - OAUTHLIB_RELAX_TOKEN_SCOPE=  # Set to 1 to allow Google OAuth to work when token scopes change
    volumes:
      - "/containers/calibre-web:/config"
      - "/path/to/books:/books"
    ports:
      - "8083:8083"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

1
2
3
4
5
6

# .env

DIRECTOR_PROJECT=calibre-web
PUID=1000
PGID=1000
TZ=UTC

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  calibre-web:
    name: calibre_web
    options:
      - container: 'args:--pull'
      - expose: '8083:8083 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - CALIBRE_WEB_CONFIG_PATH: /config
      - BOOKS_PATH: /books
volumes:
  CALIBRE_WEB_CONFIG_PATH:
    device: '/containers/calibre-web'
  BOOKS_PATH:
    device: '/path/to/books'

1
2
3
4
5
6
7

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/calibre-web:${tag}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

services:
  calibre-web:
    name: calibre-web
    image: "ghcr.io/daemonless/calibre-web:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/containers/calibre-web:/config"
      - "/path/to/books:/books"

Open http://<server>:8083 from another machine (the server's own browser can't use a published port).

Interactive Configuration

Parameters

Environment Variables

Volumes

Ports

Initial Setup & Default Login

The Web UI is available at http://your-ip:8083.

Default admin login: * Username: admin * Password: admin123

Change the default password immediately after signing in, or set CALIBRE_ADMIN_PASSWORD in your environment.

If /books is empty on first boot, a clean starter metadata.db is created automatically and /books is pre-configured as your Calibre library with uploads enabled. If you mount an existing Calibre library containing metadata.db at /books, it is linked automatically on first boot.

Resetting a Forgotten Password

cps is wrapped with daemonless-cli and CALIBRE_DBPATH=/config is set in the container environment, so you can reset any user's password directly as the bsd user:

1

podman exec -it calibre-web cps -s <user>:<pass>

Included External Binaries

• Kepubify (/usr/local/bin/kepubify) for EPUB-to-KEPUB conversion and Unrar (/usr/local/bin/unrar) for CBR comic extraction are installed and pre-configured in /config/app.db.

Migrating from LinuxServer (lscr.io/linuxserver/calibre-web)

This image uses the same /config and /books volume layout as linuxserver/calibre-web. Copy your /config and /books directories to your FreeBSD host; on startup, the init script automatically updates Linux /usr/bin/kepubify and /usr/bin/unrar paths in app.db to /usr/local/bin.

The image never changes ownership inside /books: the library must be writable by PUID/PGID. A library carried over from LinuxServer is owned by the PUID it ran with; use the same one here, or chown -R it once before the first start.

Need help? Join our Discord community.