Tome
Getting started

First-run setup

The first time you load Tome, a setup wizard creates your admin account. From there it's a short hop to scanning your library and seeing books on the dashboard.

Reading time —

Create the admin account

  1. Open http://localhost:8080 (or wherever your reverse proxy points).
  2. Fill in username, email, password.
  3. Submit. You're logged in as the admin.

Scan your library

Whatever you mounted at /books (or pointed TOME_LIBRARY_DIR at) is your library root. From the dashboard, click Scan library — Tome walks the directory tree and imports every EPUB, CBZ, CBR, and PDF it finds.

Metadata is pulled from the file itself (EPUB OPF, CBZ ComicInfo.xml, PDF info), with the filename used as a fallback for title, author, series, and volume index.

Fetch richer metadata (optional)

Tome can fetch description and cover art from Hardcover, Google Books, and Open Library. Hardcover has the best coverage for modern fiction and manga — grab a free API token at hardcover.app/account/api and set TOME_HARDCOVER_TOKEN in your compose file.

Without a Hardcover token, Tome still uses Google Books and Open Library — the lookup just skips one source.

Hook up KOReader

The single thing that makes Tome more than "another web library" — the KOReader plugin. 30 seconds, no manual config:

  1. In Tome, open Settings → KOReader.
  2. Click Download Plugin. You get a .koplugin file pre-baked with your server URL and a fresh API key.
  3. Drop it into your reader's plugins/ folder, restart KOReader.
  4. Reading sessions start syncing immediately. Full instructions.

Where to go next

  • Invite users — turn this into a family / friend share.
  • Bindery — set up the drop folder so future imports happen without re-scanning.
  • Reading stats — once a few sessions have landed, the dashboards start filling in.