Athenaeum

Warning

This project is still alpha level software and being actively developed.

Self-hosted library for EPUB, PDF, comics, audiobooks and much more. Single static portable binary.

Install

Installer

curl -fsSL https://raw.githubusercontent.com/Quad4-Software/Athenaeum/master/install.sh | bash

Or download and run it interactively:

curl -fsSL -o install.sh https://raw.githubusercontent.com/Quad4-Software/Athenaeum/master/install.sh
chmod +x install.sh
./install.sh

Docker (GHCR)

docker run -d --name athenaeum \
  -p 8080:8080 \
  -v athenaeum-data:/data \
  -v /path/to/books:/library \
  ghcr.io/quad4-software/athenaeum:latest

Pin a release with ghcr.io/quad4-software/athenaeum:v0.1.0 (or another tag). latest tracks master. Version tags publish on v* releases.

Docker Compose

git clone https://github.com/Quad4-Software/Athenaeum.git
cd Athenaeum
cp .env.example .env
# set ATHENAEUM_LIBRARY_HOST_PATH to your media folder
docker compose up -d

docker compose up -d pulls ghcr.io/quad4-software/athenaeum:latest. Use docker compose up -d --build to build locally instead.

Open http://localhost:8080. Create an admin in the setup wizard, or pass --admin-user / --admin-pass when no users exist yet.

Build from source

Requires Go 1.26+, Node 22+, and pnpm 11+. Task is optional. Make works for build and install.

git clone https://github.com/Quad4-Software/Athenaeum.git
cd Athenaeum

Task

task setup
task build
./bin/athenaeum --addr :8080 --library /path/to/books --data ./data

Make

cd web && pnpm install && cd ..
make build
./bin/athenaeum --addr :8080 --library /path/to/books --data ./data

make help lists targets (build, install, clean, and so on).

Manual

go mod download
cd web && pnpm install && pnpm build && cd ..
mkdir -p bin
go build -trimpath -o bin/athenaeum ./cmd/athenaeum
./bin/athenaeum --addr :8080 --library /path/to/books --data ./data

Verify a build with ./bin/athenaeum --self-check (dirs, database, HTTP). Release tags publish binaries for Linux (amd64/arm64/armv6/armv7/riscv64), macOS, Windows, FreeBSD, OpenBSD, and NetBSD. Container images go to GHCR on master (:latest) and on v* tags.

Documentation

Docs are a Docusaurus site in docs/ (content in docs/docs/). Agent writing and coding conventions live in AGENTS.md and .agents/.

task docs:dev      # http://localhost:3000
task docs:build    # docs/build (GitHub Pages artifact)

cd docs && pnpm install && pnpm start    # http://localhost:3000
cd docs && pnpm install && pnpm build    # docs/build

• Introduction
• Getting started
• Features
• Deploying
• Authentication
• CLI users
• Library and readers
• OPDS and KOSync
• Operations
• Development
• Configuration
• HTTP API
• Project layout

Changelog

See CHANGELOG.md.

Security

See SECURITY.md for supported versions and how to report vulnerabilities privately.

License

MIT