Quick Start

Quick Start

The fastest path to a running library. For a fully-documented compose file and per-platform (Synology, Unraid, Portainer, TrueNAS) guides, see Installation.

Requirements: Docker and Docker Compose.

1. Make a folder for your library:

   mkdir -p ~/calibre-web/{config,library,ingest}
   cd ~/calibre-web

2. Save this as docker-compose.yml:

   services:
     calibre-web:
       image: ghcr.io/new-usemame/calibre-web-nextgen:latest
       container_name: calibre-web
       environment:
         - PUID=1000
         - PGID=1000
         - TZ=America/New_York   # change to your timezone
       volumes:
         - ./config:/config            # settings, user db, logs
         - ./library:/calibre-library  # books live here
         - ./ingest:/cwa-book-ingest   # drop new books here to import
       ports:
         - 8083:8083
       restart: unless-stopped

3. Start it:

   docker compose up -d

4. Open http://localhost:8083, log in with admin / admin123, change the password.

Drop an .epub into ./ingest/ and it will appear in your library within a few seconds.

Files in your library and ingest folders should be owned by your PUID:PGID user (1000 by default), not root. If you've copied books in as root, run once: sudo chown -R 1000:1000 ~/calibre-web.

Next: finish the First Run setup (change the password, enable uploads).