Tome

# Run Tome from the published container image. Works on any host
# (Linux / macOS / Windows) for amd64 and arm64.
#
#   docker compose pull && docker compose up -d
#
# Customise the volume paths below if your library and data live elsewhere.
# See docs/examples/ for setups specific to Unraid, etc.
services:
  tome:
    image: ghcr.io/bndct-devops/tome:latest
    container_name: tome
    ports:
      - "8080:8080"
    volumes:
      # State (SQLite DB, cover cache, generated secret key)
      - ./data:/data
      # Your ebook library. Read-write so Tome can organise files.
      - ./books:/books
      # Drop new files here for Bindery to pick up
      - ./bindery:/bindery
    environment:
      # Optional. Run Tome as this host UID/GID (default 1000:1000) so it can
      # read/write your mounts. Set to the user that owns ./books and ./bindery
      # on the host - on Synology / QNAP / TrueNAS use your docker user's ids
      # (`id <user>`). Only needed if you see PermissionError in the logs.
      # - PUID=1000
      # - PGID=1000
      # Optional. If unset, Tome generates a long random key on first start
      # and saves it to /data/secret.key.
      # - TOME_SECRET_KEY=
      # Or read it from a file (Docker secrets); any secret takes a _FILE variant.
      # - TOME_SECRET_KEY_FILE=/run/secrets/tome_secret_key
      # Optional. Get a free API token at https://hardcover.app/account/api
      # - TOME_HARDCOVER_TOKEN=
      # Optional. Set to true to automatically import files from /bindery.
      # - TOME_AUTO_IMPORT=true
    restart: unless-stopped