Host your books, sync reading progress, and share libraries. Quire Server includes the browser reader and an administration panel, with separate accounts for personal books, notes, and highlights.
Docker image · Download the reader · Deployment guide · API reference
Direct source URL. The reader is also available for Windows, Linux, and Android. iOS IPAs need signing in your sideloading app.
The prebuilt Docker image includes the server and WebUI for AMD64 and ARM64.
mkdir quire-server
cd quire-server
curl -fsSLO https://raw.githubusercontent.com/astraldeath/quire-server/main/compose.yaml
printf 'QUIRE_PUBLIC_URL=https://books.example.com\n' > .env
docker compose up -d
docker compose logs quireReplace https://books.example.com with your public address. Point your reverse proxy or host-installed Cloudflare Tunnel at http://127.0.0.1:8080. The supplied Compose file binds that port to localhost. A Cloudflare Tunnel handles public HTTPS; it does not need Caddy alongside it.
Open your public address and enter the one-time setup code from the logs to create the administrator account. For a local trial, set QUIRE_PUBLIC_URL=http://localhost:8080 and open that address instead.
Books and account data are stored in the quire-data volume. See production deployment for proxy setup, storage, and upgrades.
- A browser reader with personal uploads and shared libraries.
- Progress, bookmarks, highlights, notes, folders, privacy settings, and reading-history sync with Quire apps.
- Account invitations, roles, device revocation, and shared-library membership.
- Watched folders that import books without moving the source files.
- MangaBaka OAuth and tracking for the hosted reader.
- OPDS 1.2 and 2.0 feeds with revocable app passwords, plus a proxy for external catalogs.
- Server backups and restore commands.
Supported files include EPUB, PDF, CBZ, CBR, CB7, FB2/FBZ, and DRM-free MOBI/AZW3. Uploads default to 2 GiB per book. File formats and limits explains configuration and archive support.
Back up the server data before upgrading, then run:
docker compose pull
docker compose up -dThe data volume is retained. The latest image follows successful builds from main; version and commit tags are also available.
The image uses reader commit c643aa308d426204b16f2f54c4640d1e9e19cf7c. Source builds can select another revision with QUIRE_READER_REF.
| Guide | Contents |
|---|---|
| Production deployment | Docker, HTTPS, reverse proxies, and upgrades |
| Operations | Commands, configuration, accounts, watched folders, and file limits |
| Backups | Backup, restore, and recovery |
| Tracking | MangaBaka OAuth setup |
| OPDS | Catalog feeds, app passwords, and external sources |
| API | Authentication, uploads, and synchronization |
| OpenAPI contract | Endpoint schemas |
| CI caches | Workflow cache configuration |
Source builds require Go 1.27.1 or newer. Build the browser reader alongside this repository:
cd ../quire-reader
npm ci
npm run build:web
cd ../quire-server
go build -o bin/quire-server ./cmd/quire-server
bin/quire-server serve -web-dir ../quire-reader/dist-webRun the server checks:
go test ./...
go vet ./...To build the Docker image locally:
docker compose -f compose.yaml -f compose.build.yaml up -d --buildThe server is AGPL-3.0-only. The API contract is separately licensed under MIT, as is the Quire reader. Quire is pronounced “kwire”, rhyming with “choir”.