diff --git a/docs/developer/api/authentication/overview.md b/docs/developer/api/authentication/overview.md index 056f5bb..c907485 100644 --- a/docs/developer/api/authentication/overview.md +++ b/docs/developer/api/authentication/overview.md @@ -158,7 +158,7 @@ The frontend toast.js interceptor: - **Backend**: Automatically manages HTTP-only cookie - **Frontend**: Store tokens in localStorage for API calls -### Mobile Applications +### Mobile Applications (coming later) - Store access token in secure storage (Keychain/Keystore) - Store refresh token in secure storage diff --git a/docs/user/calibre-integration.md b/docs/user/calibre-integration.md index 8f414bc..30f29ad 100644 --- a/docs/user/calibre-integration.md +++ b/docs/user/calibre-integration.md @@ -259,12 +259,11 @@ Stay tuned for updates! ### OPDS Integration -You can access your Bookhoard library (including Calibre-imported books) via OPDS from Calibre-aware devices: -- Kobo e-readers -- KOReader +You can access your Bookhoard library (including Calibre-imported books) via OPDS from OPDS-capable clients: +- KOReader (Kindle, Kobo, PocketBook hardware) - Phone/tablet apps (KYBook, Chunky, etc.) -See the [Kobo Setup Guide](devices/kobo-setup.md) or [KOReader Setup Guide](devices/koreader-setup.md) for details. +See the [KOReader Setup Guide](devices/koreader-setup.md) for details. ## FAQ diff --git a/docs/user/sync-guide.md b/docs/user/sync-guide.md index b8adf15..519c5b1 100644 --- a/docs/user/sync-guide.md +++ b/docs/user/sync-guide.md @@ -21,7 +21,7 @@ 🔄 **Automatic Sync** - Your reading progress syncs automatically when you turn pages -📱 **Multi-Platform** - Works with web browsers, KOReader, Kobo devices, and mobile apps +📱 **Multi-Platform** - Works with web browsers and KOReader, with native Kobo sync and mobile apps on the roadmap 📍 **Precise Location Tracking** - Supports EPUB CFI, page numbers, percentages, and character offsets @@ -37,19 +37,24 @@ ### Currently Supported ✅ -| Platform | Status | Sync Method | Notes | -| ---------------- | ------------------ | --------------------------- | ------------------------------ | -| **Web Browser** | ✅ Fully Supported | Real-time WebSocket | Any modern browser | -| **KOReader** | ✅ Fully Supported | Wi-Fi (Calibre-compatible) | Kindle, Kobo, PocketBook, etc. | -| **Kobo Devices** | ✅ Fully Supported | Wi-Fi (Kobo API-compatible) | Clara, Libra, Sage, etc. | +| Platform | Status | Sync Method | Notes | +| ---------------- | ------------------ | --------------------------- | ---------------------------------- | +| **Web Browser** | ✅ Fully Supported | Real-time WebSocket | Any modern browser | +| **KOReader** | ✅ Fully Supported | Wi-Fi (Bookhoard plugin) | Kindle, Kobo, PocketBook hardware | ### Coming Soon 🚧 -| Platform | Expected Release | -| --------------------- | ---------------- | -| **Mobile Apps** | Q2 2026 | -| **Kindle Devices** | Q3 2026 | -| **Remarkable Tablet** | Q4 2026 | +| Platform | Status | +| --------------------- | ------------------------------------------------------------- | +| **Kobo Devices** | Native sync coming soon — use KOReader on Kobo hardware today | +| **Mobile Apps** | Android/iOS apps coming later | + +### On the Roadmap 🔭 + +| Platform | Status | +| --------------------- | ---------------------------------------- | +| **Kindle Devices** | Under consideration (no date yet) | +| **Remarkable Tablet** | Under consideration (no date yet) | --- @@ -74,17 +79,16 @@ For detailed device configuration instructions, see the appropriate setup guide: -- **[Kobo Setup Guide](devices/kobo-setup.md)** - Kobo e-reader configuration -- **[KOReader Setup Guide](devices/koreader-setup.md)** - KOReader configuration +- **[KOReader Setup Guide](devices/koreader-setup.md)** - KOReader configuration (Kindle, Kobo, and PocketBook hardware) +- **[Kobo Setup Guide](devices/kobo-setup.md)** - Native Kobo sync (coming soon; use KOReader today) ### Quick Overview -**Registration Process**: +**Registration Process** (KOReader): -1. Register device in Bookhoard web interface (Settings → Devices) -2. Approve device via QR code or approval URL -3. Configure sync settings on your device -4. Start reading - progress syncs automatically! +1. Install the Bookhoard plugin and enter your server URL in KOReader +2. Approve the pending registration in Bookhoard (**Settings → Devices**) +3. That's it — sync starts automatically once approved **Device Management**: @@ -331,7 +335,7 @@ This ensures your highlights work across all devices, even with different page c 1. Switch to checkpoint mode 2. Increase sync interval -3. Use Wi-Fi instead of cellular (for mobile) +3. Sync less frequently --- @@ -341,7 +345,7 @@ This ensures your highlights work across all devices, even with different page c ✅ **DO**: -- Use checkpoint mode when on cellular data +- Use checkpoint mode when on slow connections - Keep device firmware updated - Use Wi-Fi when available - Approve only devices you own @@ -369,7 +373,7 @@ This ensures your highlights work across all devices, even with different page c - **Primary Device**: KOReader on e-reader - **Secondary Device**: Web browser (work/home) -- **Mobile Device**: Phone app (commute) +- **On the go**: Web browser on a phone (dedicated mobile apps coming later) **Sync Strategy**: @@ -503,9 +507,8 @@ Book → Reading History ### For Better Battery Life 1. **Checkpoint mode** - Fewer sync requests -2. **Wi-Fi only** - Disable cellular -3. **Increase sync interval** - Fewer updates -4. **Close when not reading** - Reduces background activity +2. **Increase sync interval** - Fewer updates +3. **Close when not reading** - Reduces background activity --- @@ -537,7 +540,7 @@ A: Approximately 1KB per page turn, 50KB per annotation. A: Uses percentage and EPUB CFI for universal positioning. **Q: Can I sync with Calibre anymore?** -A: Yes! KOReader sync is Calibre-compatible. +A: Bookhoard's KOReader sync uses a dedicated plugin (server-side approval, device tokens) — no Calibre involvement required. **Q: What if I lose my device?** A: Revoke it in settings and register a new one. @@ -571,18 +574,18 @@ A: Yes, HTTPS/TLS 1.3 for all sync traffic. ## Changelog -### Version 1.0.0 (January 2026) +### Version 1.0.x (2026) -- ✅ Initial release -- ✅ KOReader sync support -- ✅ Kobo device support - ✅ Web sync support +- ✅ KOReader sync (progress, bookmarks, highlights, notes) - ✅ Conflict resolution - ✅ Offline queue - ✅ Real-time WebSocket sync +- 🚧 Native Kobo sync (coming soon) +- 🚧 Mobile apps (coming later) --- -**Last Updated**: January 31, 2026 -**Version**: 1.0.0 -**License**: MIT +**Last Updated**: August 2026 +**Version**: 1.0 +**License**: GPL-3.0 diff --git a/docs/user/user-guide.md b/docs/user/user-guide.md index d3a5c6b..583e442 100644 --- a/docs/user/user-guide.md +++ b/docs/user/user-guide.md @@ -6,18 +6,16 @@ Welcome to the Bookhoard user documentation. This section contains guides for us Learn how to configure your e-reader devices to sync with Bookhoard: -- **[Kobo Setup Guide](devices/kobo-setup.md)** - Complete guide for Kobo e-readers - - Device registration - - Sync configuration - - OPDS wireless book delivery - - Troubleshooting - - **[KOReader Setup Guide](devices/koreader-setup.md)** - Complete guide for KOReader - Installation on Kindle/Kobo/PocketBook - - Sync setup + - Plugin setup with server-side device approval + - Progress, bookmark, highlight, and note sync - OPDS catalog access - Troubleshooting +- **[Kobo Setup Guide](devices/kobo-setup.md)** - Native Kobo sync (coming soon) + - In the meantime, KOReader works great on Kobo hardware + ## 🔄 Sync Configuration - **[Universal Sync Guide](sync-guide.md)** - Understanding and using sync features