John O'Keefe
0d4698c0de
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.
3.0 KiB
3.0 KiB
Admin Guide
Everything an instance administrator runs lives in this section. Like the rest of Bookhoard's docs, pages tell you what to click — but admin pages add the layer users don't need: what each control actually does before you click it, what it costs, and what it changes. (The calibration, if you're curious: user docs = what you see, admin docs = what it does, developer docs = how it works.)
The Administration section
| Page | What it covers |
|---|---|
| Dashboard | The /admin landing page: stats, file-watcher status, Force Rescan All Libraries, live scan progress |
| Libraries | Creating libraries, folders, per-user visibility, per-library scans, deletion semantics |
| Processing Issues | Per-library ledger of items the scanner couldn't process — Retry, Retry all, Dismiss |
| Archived Items | The missing-file lifecycle: two-strikes archiving, Merge/Restore/Delete, retention |
| Podcasts | The all-feeds maintenance view: disk usage, refresh, delete files, remove for everyone |
| Hash Conflicts | Byte-identical duplicates and their resolution (merge reading data or keep both) |
| Users | Accounts, roles, password resets, the last-admin guards |
| Settings | Every server-wide setting: key, default, range, what it does, restart or live |
| Scanning | The deep-dive: shallow vs. force, and what every scan button actually does |
The app's own sidebar shows the first six as the Administration group; Processing Issues and Archived Items hang off the Libraries page.
If you're setting up a fresh instance
The shortest sane path, in order:
- Libraries → Create Library, add its folders
- Let the initial scan populate it (or Force Rescan to be sure)
- Settings → set the Base URL to the address other devices will use, and check Auto-Scan is on
- Users → create accounts (or leave public registration on), set roles
- Point devices at the server — the device guides walk each one
When something looks wrong
- Books vanished from the library? Archived Items — they're almost certainly there, history intact.
- A book's metadata is stale or wrong? Open the book → Rescan (re-extracts that one item, sidecars included).
- Duplicates? Hash Conflicts.
- A scan didn't pick up your changes? Scanning explains which scans skip unchanged files — and which never do.