Commit Graph
5 Commits
Author SHA1 Message Date
john-okeefe 249085d942 docs: update implementation plan with API key authentication strategy
- Replace serial number approach with API key in URL path for Kobo
- Add authentication strategy section documenting Kobo and KOReader methods
- Update unified authentication architecture to support URL path parameters
- Document Komga-proven approach for stock Kobo firmware
- Update feature matrix with new authentication methods
- Revise user flows for API key-based registration
- Clarify OPDS security (already using DeviceAuthMiddleware)
- Update security considerations to reflect revocable API keys
2026-02-12 10:52:50 -05:00
john-okeefe b1345e1ad7 docs: add critical modifications section to implementation plan
- Section 14: Critical Modifications Required
  - Missing GetDeviceByDeviceIdentifier query requirement
  - Incorrect Kobo documentation (wrong auth mechanism)
  - OPDS authentication inconsistency (needs dual header/URL fallback)
  - Enhanced security documentation requirements

- Section 15: Updated success criteria
  - Database query requirements
  - Documentation accuracy requirements
  - Dual authentication support

These modifications address blockers identified during codebase review
before implementation begins.
2026-02-11 21:03:39 -05:00
john-okeefe 15642f7feb docs: add comprehensive device authentication implementation plan
Add detailed implementation plan covering:
- Enhanced authentication middleware (Bearer + serial)
- Kobo native sync with serial-based auth
- KOReader plugin development plan
- OPDS security hardening
- Parallel implementation tracks
- Complete historical context and decision rationale

This plan documents the strategy to transform Bookhoard into a
Kindle-replacement ecosystem with full sync support for both
Kobo (native) and KOReader (via plugin) devices.

Key decisions:
- Kobo: Serial number authentication (simplest UX)
- KOReader: Bearer token via plugin (most secure)
- Plugin: Separate repository under Bookhoard org
- Implementation: Parallel tracks for faster delivery
2026-02-11 20:54:01 -05:00
john-okeefe a2b26e68c5 chore: remove obsolete implementation plan documents 2026-02-01 13:21:39 -05:00
john-okeefe 33f26f3d7d docs: add implementation plan and update documentation
- Add comprehensive implementation plan for universal sync system
- Update README with API reference and device setup guides
- Add KOBO_SETUP.md device configuration guide
2026-01-31 18:25:27 -05:00