# Athenaeum

> Self-hosted library for EPUB, PDF, comics, and audiobooks. One Go binary or one Docker image; point it at a media folder to get browser readers, search, shelves, optional multi-user auth, and OPDS.

Athenaeum listens on :8080 by default and keeps state in its --data directory. Server settings are CLI flags or ATHENAEUM_* environment variables. The container image is ghcr.io/quad4-software/athenaeum and the source is at github.com/Quad4-Software/Athenaeum.

## Deploy

- [Getting started](https://athenaeum.quad4.io/docs/getting-started): install.sh, docker run, Compose, release binary, or source build
- [Deploying](https://athenaeum.quad4.io/docs/deploying): installer flags, Compose profiles (altcha, kokoro, postgres), host service units, backups
- [Configuration](https://athenaeum.quad4.io/docs/configuration): every CLI flag and ATHENAEUM_* env var with defaults
- [Operations](https://athenaeum.quad4.io/docs/operations): metrics, health checks, maintenance tasks, webhooks, backup API

## Operate

- [Authentication](https://athenaeum.quad4.io/docs/authentication): first admin, sessions, guests, invites, TOTP, OIDC/Pocket ID, API keys, ALTCHA
- [CLI users](https://athenaeum.quad4.io/docs/cli-users): offline account management via `athenaeum users`
- [Library and readers](https://athenaeum.quad4.io/docs/library): formats, S3 mounts, metadata providers, BibTeX, narration, sharing
- [OPDS and KOSync](https://athenaeum.quad4.io/docs/catalogs): e-reader catalog feeds and KOReader progress sync endpoints
- [HTTP API](https://athenaeum.quad4.io/docs/http-api): full REST route reference

## Contribute

- [Features](https://athenaeum.quad4.io/docs/features): capability list and tech stack
- [Development](https://athenaeum.quad4.io/docs/development): Task targets, test methods, and CI workflows
- [Project layout](https://athenaeum.quad4.io/docs/project-layout): repository directory map

## Optional

- [Introduction](https://athenaeum.quad4.io/docs/intro): product overview and fit
- [Roadmap](https://athenaeum.quad4.io/roadmap): planned work
- [Privacy](https://athenaeum.quad4.io/privacy): data handling stance
- [GitHub](https://github.com/Quad4-Software/Athenaeum): source, issues, and releases