Files
bookhoard/docs/user/user-guide.md
T
John O'Keefe b4b1deafb8 docs(user): Android app guide — LAN setup and the Android 16+ local-network permission
Android 16+ gates per-app access to local networks behind a runtime
permission; without it the app's LAN logins time out with zero packets
leaving the phone (browser works — it is not per-app-gated). The new
device guide covers the sideload install, first-run server URL, the
permission prompt (and manual re-grant path), and a triage table for
the login screen's error line. Per the user: overlay-VPN addresses are
not a consideration and stay undocumented.
2026-09-29 18:12:57 -04:00

2.3 KiB

User Documentation

Welcome to the Bookhoard user documentation. This section contains guides for using Bookhoard features, setting up devices, and configuring sync.

📱 Device Setup

Learn how to configure your e-reader devices to sync with Bookhoard:

  • Android App Guide - The native Android client

    • Installing and upgrading the APK
    • Connecting to a self-hosted server over LAN
    • The Android 16+ local-network permission
    • Troubleshooting login failures
  • KOReader Setup Guide - Complete guide for KOReader

    • Installation on Kindle/Kobo/PocketBook
    • Plugin setup with server-side device approval
    • Progress, bookmark, highlight, and note sync
    • OPDS catalog access
    • Troubleshooting
  • Kobo Setup Guide - Native Kobo sync (coming soon)

    • In the meantime, KOReader works great on Kobo hardware

🔄 Sync Configuration

  • Universal Sync Guide - Understanding and using sync features
    • What is Universal Sync?
    • Supported devices
    • Book matching and auto-linking
    • Conflict resolution
    • Best practices

📚 Calibre Integration

  • Calibre Integration Guide - Integrating with Calibre libraries
    • What is Calibre?
    • Automatic metadata import
    • Setting up your Calibre library
    • Supported metadata and file types
    • Workflow examples
    • Troubleshooting
    • Best practices

📖 Reading

  • Web Reader Guide - Reading and annotating in the browser
    • Touch navigation (swipe to page, tap for menu)
    • Selecting text: long-press, drag, handles
    • Highlights, notes, copy, and editing
    • PDFs and comics

🎨 Frontend Guide

Frontend Guide - Learn how to use the Bookhoard web interface

  • Coming Soon

👤 User Areas

User Areas Guide - Managing your personal library and settings

  • Coming Soon

⚙️ Settings

Settings Guide - Configuring your Bookhoard preferences

  • Coming Soon

🔐 Admin Features

Admin Guide - Administrative functions and management

  • Coming Soon

Looking for developer documentation? See the Developer Portal