getcoral/fathom repository overview

⁠Fathom

⁠What It Is

Fathom is the Coral reading room. It connects to Jellyfin and turns reading libraries into a cleaner browsing experience with:

• a featured shelf
• recent additions
• library browsing
• collection browsing
• title detail with contributors and metadata
• local SQLite-backed Jellyfin connection settings, with .env support

⁠Development

pnpm install
pnpm dev

Fathom runs on http://localhost:3000.

⁠Configuration

Fathom supports the same connection model as other Coral modules:

JELLYFIN_URL=http://your-server:8096
JELLYFIN_API_KEY=your-api-key
JELLYFIN_USER_ID=your-user-id
JELLYFIN_USERNAME=optional-username
JELLYFIN_PASSWORD=optional-password

If those environment variables are present, Fathom can skip initial homepage onboarding. You can still edit and save local overrides through /setup.

By default, local settings are stored in:

./data/fathom.sqlite

Override the data directory with:

FATHOM_DATA_DIR=/path/to/data

⁠Docker

The published image is getcoral/fathom⁠:

docker run -p 3000:3000 \
  -e JELLYFIN_URL=http://your-nas:8096 \
  -e JELLYFIN_API_KEY=your-key \
  -e JELLYFIN_USER_ID=your-user-id \
  getcoral/fathom:latest

Or build it yourself:

docker build -t fathom .

Published automatically to getcoral/fathom⁠ on Docker Hub on every release via GitHub Actions.

⁠Scripts

pnpm dev
pnpm build
pnpm start
pnpm typecheck
pnpm test
pnpm check

⁠Part Of Coral

Fathom is part of the Coral⁠ ecosystem. Shared Jellyfin API work belongs in @get-coral/jellyfin⁠, while Fathom-specific reading workflows stay in this repo.