Skip to content

Fathom

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, and rich title details with metadata.

A cover-first interface designed for a calm, focused reading experience.

Fathom provides:

  • Featured shelf - Curated reading selections
  • Recent additions - New books, manga, comics
  • Library browsing - Organized by collections
  • Collection browsing - Group related content
  • Title detail - Complete metadata and contributor information
  • Local connection - SQLite-backed Jellyfin settings, with .env support
  • Books (EPUB, PDF, etc.)
  • Manga
  • Comics
  • Audiobooks and more
  • Node.js 18+
  • pnpm (or npm/yarn)
  • Running Jellyfin server with reading library
  1. Clone the repository:
Terminal window
git clone https://github.com/Get-Coral/fathom.git
cd fathom
  1. Install dependencies:
Terminal window
pnpm install
  1. Configure environment variables:
Terminal window
JELLYFIN_URL=http://your-server:8096
JELLYFIN_API_KEY=your-api-key
JELLYFIN_USER_ID=your-user-id

Connection details can also be configured in the web UI on first run, and will be stored locally in SQLite.

  1. Start the development server:
Terminal window
pnpm dev

Fathom runs on http://localhost:3000

Fathom supports the same connection model as other Coral modules.

Terminal window
JELLYFIN_URL=http://your-server:8096
JELLYFIN_API_KEY=your-api-key
JELLYFIN_USER_ID=your-user-id

If these are not set, Fathom will open a setup screen on first run and store the connection details locally.

Connection settings are stored in SQLite at ./data/fathom.sqlite for a self-hosted setup without external database requirements.

  • View all reading libraries
  • Browse by collection
  • Search across your library
  • Filter by media type
  • Featured and highlighted titles
  • Recent additions
  • Curated collections
  • Recommendation algorithms
  • Track reading progress
  • Mark as favorites
  • Create personal collections
  • Rating and reviews
  • Full book information
  • Contributors and authors
  • Descriptions and summaries
  • Cover art and thumbnails

Fathom is built with:

  • src/routes/ - Page components
  • src/components/ - Reusable UI components
  • src/lib/ - Utilities and helpers
  • src/data/ - Data directory for SQLite

Deploy Fathom to:

  • Vercel
  • Docker
  • Self-hosted servers

For production:

Terminal window
pnpm build
pnpm preview

Get-Coral/fathom on GitHub