Files
bookhoard/docs/user/user-guide.md
T
John O'Keefe 0d4698c0de docs(admin): admin-guide front door + Administration area in the portal
The tenth and final page: the section directory with one-line coverage
per page, the fresh-instance quick path (libraries -> scan -> Base URL
-> users -> devices), and the when-something-looks-wrong triage table
mapping symptoms to pages. The portal (index.md) gains a For
Administrators area listing all nine admin pages; the user guide's
'being expanded separately' line becomes the done-state sentence.
Every control name quoted here exists in the glossary.
2026-11-02 14:17:13 -05:00

2.4 KiB

Bookhoard — start here

Bookhoard is a self-hosted home for the things you read and hear: your book libraries live on your own server, you read them in the browser or on your devices, and everything keeps track of where you are.

The moving parts, in one breath:

  • Libraries hold your books (and your podcasts run as feeds of their own)
  • The dashboard is your home screen — shelves that update themselves
  • Collections are shelves you build, by hand or by rules
  • Filters answer "which books match?" — the same rules power saved filters, smart collections, and dashboard shelves
  • Devices — the Android app, KOReader on e-readers, and stock Kobo firmware — stay in step with the server through sync
  • Your profile holds your preferences: theme, playback defaults, password

Where to go

You want to... Read
Learn the layout: dashboard, shelves, customizing Dashboard
Browse, search, and sort your books Browsing your library
Build shelves — by hand or with rules Collections
Narrow with rules, save them, reuse them Filters — the complete guide
Subscribe to shows, download, listen Podcasts
Read and annotate in the browser Web Reader Guide
Change themes and bookshelf textures Themes and Wood Paneling
Edit your account, password, playback defaults Your profile
Get the Android app talking to your server Android App
Use KOReader on an e-reader KOReader Setup
Use a Kobo Kobo Setup
Understand how it all stays in sync Universal Sync Guide
Import from Calibre Calibre Integration

New here? The usual path is: browse your library, open a book, and let the dashboard keep track of you. Sync comes when you add a device.

A note on admins

Some screens (user management, server settings, library folders) are admin territory; Admin Guide is the door, and the Administration docs section covers every admin page.

Looking for developer documentation? See the Developer Portal.