john-okeefe
4d321528b2
This commit updates all documentation files throughout the project: - Updated IMPLEMENTATION_PLAN.md with new implementation details - Updated PROJECT_GUIDELINES.md with coding standards and practices - Updated README.md with current project information - Updated SCREENSHOT_AUTOMATION.md with new automation details - Added TEST_DATA.md with test fixtures data - Updated cover_image_serving_plan.md with static URL patterns Documentation API updates: - Updated API reference documentation for all endpoints including: - Authentication (login, logout, register, refresh_token) - Book matching (auto_link, bulk_link, link_book, search) - Collections (CRUD operations, shelf mappings, auto-assign rules) - Conflicts (bulk operations, resolve/dismiss) - Devices (registration, approval, shelf management) - Highlights (create, update, delete, get) - Kobo sync (bookmark, markup, initialization, sync) - KOReader sync (library, metadata, bookmarks, progress) - Libraries (CRUD, folders, media items, stats) - Media items (bulk operations, CRUD) - Notes (CRUD operations) - OPDS (acquisition, feeds, publication) - Progress (reading progress tracking) - Queue (device queue management) - Ratings (star ratings) - Scanner (watch mode, scan operations) - Sync protocols (Kobo, KOReader) - Users (profile, password, admin operations) - WebSocket protocols - Updated user guides (admin, dashboard, settings, sync) - Updated device setup guides (Kobo, KOReader) - Updated developer guides (testing, contributing, operations) - Updated scripts/README.md
172 lines
5.6 KiB
Markdown
172 lines
5.6 KiB
Markdown
# 📚 Bookhoard
|
|
|
|
A modern self-hosted media library system built with Go, PostgreSQL, HTMX, and Tailwind CSS featuring **universal cross-device sync**, beautiful dark themes, and comprehensive media management.
|
|
|
|
## ✨ Why Bookhoard?
|
|
|
|
**🔄 Universal Sync**: Your reading progress, highlights, and notes sync automatically across all your devices - KOReader, Kobo, web, and mobile.
|
|
|
|
**📱 Multi-Library**: Organize your ebooks, comics, and manga with per-library folders and smart collections.
|
|
|
|
**🎨 Beautiful UI**: 11 gorgeous dark themes with responsive design that works on any device.
|
|
|
|
**🔒 Secure**: JWT authentication, bcrypt password hashing, rate limiting, and no passwords on devices.
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Prerequisites
|
|
|
|
- **Podman** (recommended) or Docker
|
|
- **5 minutes** of your time
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
# 1. Clone the repository
|
|
git clone https://github.com/yourusername/bookhoard.git
|
|
cd bookhoard
|
|
|
|
# 2. Set up environment
|
|
cp .env.example .env
|
|
# Generate secure passwords (no special characters):
|
|
# JWT_SECRET: openssl rand -hex 32
|
|
# DBPASS: openssl rand -hex 16
|
|
# Edit .env with your generated values
|
|
|
|
# 3. Start the server
|
|
podman-compose up --build -d # or: docker-compose up --build -d
|
|
|
|
# 4. Open your browser
|
|
open http://localhost:8765
|
|
```
|
|
|
|
The first user to register automatically becomes an admin.
|
|
|
|
---
|
|
|
|
## 📖 Key Features
|
|
|
|
### Universal Cross-Platform Sync
|
|
|
|
- **Real-Time Progress**: Turn a page on your Kindle, see it on your phone
|
|
- **Format-Aware**: EPUB CFI, page numbers, percentages - all handled correctly
|
|
- **Offline Queue**: Changes sync when you reconnect, priority-processed
|
|
- **Conflict Resolution**: Smart handling when same book read on multiple devices
|
|
- **Book Matching**: Automatic matching using SHA-256, ISBN, UUID
|
|
- **OPDS Catalog**: Wireless book delivery to e-readers over Wi-Fi
|
|
- **Format Conversion**: On-the-fly EPUB→KEPUB for Kobo devices
|
|
|
|
### Media Management
|
|
|
|
- **Smart Search**: Partial matching with fuzzy search fallback for typos
|
|
- **Advanced Filtering**: Filter by author, series, genre, language, year, cover images
|
|
- **Dynamic Sorting**: By title, author, date added, published date, page count, series
|
|
- **Rich Metadata**: Title, author, series, publisher, ISBN, language, edition, tags
|
|
- **5-Star Ratings**: Half-star precision (1-10 scale)
|
|
- **Notes & Highlights**: Color-coded annotations with linked notes
|
|
- **Usage Analytics**: Reading statistics, device usage, popular books
|
|
|
|
### Smart Collections
|
|
|
|
- **Auto-Assign Rules**: Automatically add books based on genre, author, series, tags, language, publisher, year
|
|
- **Device Shelf Mappings**: Sync collections to Kobo shelves and KOReader categories
|
|
- **Test Before Creating**: Preview which books match your rules
|
|
|
|
### Library Organization
|
|
|
|
- **Multi-Library Support**: Ebooks, Comics, and Manga with type-specific file formats
|
|
- **Multiple Folders**: Add multiple scanning folders per library
|
|
- **Visibility Control**: Admins control which libraries each user can see
|
|
- **Background Scanning**: Auto-scan with per-user frequency settings
|
|
- **Watch Mode**: Real-time file system monitoring for instant updates
|
|
|
|
### Security
|
|
|
|
- **JWT Authentication**: Short-lived access tokens (1 hour) with refresh tokens (7 days)
|
|
- **Strong Passwords**: Complexity requirements enforced (8+ chars, uppercase, lowercase, number, special)
|
|
- **Account Lockout**: 5 failed attempts = 15-minute lockout
|
|
- **Rate Limiting**: 10 requests/minute on auth endpoints
|
|
- **Input Validation**: Comprehensive validation on all inputs
|
|
- **No Passwords on Devices**: Web-based device approval with QR codes
|
|
|
|
---
|
|
|
|
## 📚 Documentation
|
|
|
|
### For Users & Self-Hosters
|
|
|
|
- **[docs/user/sync-guide.md](docs/user/sync-guide.md)** - Understanding and using universal sync
|
|
- **[docs/user/devices/kobo-setup.md](docs/user/devices/kobo-setup.md)** - Kobo e-reader configuration
|
|
- **[docs/user/devices/koreader-setup.md](docs/user/devices/koreader-setup.md)** - KOReader configuration
|
|
- **[docs/user/user-guide.md](docs/user/user-guide.md)** - General user guide
|
|
- **[docs/user/admin-guide.md](docs/user/admin-guide.md)** - Admin features and configuration
|
|
- **[docs/user/settings-guide.md](docs/user/settings-guide.md)** - Settings and preferences
|
|
|
|
### For Developers
|
|
|
|
- **[docs/developer/api/api-reference.md](docs/developer/api/api-reference.md)** - Complete API documentation
|
|
- **[docs/contributing/DEVELOPMENT.md](docs/contributing/DEVELOPMENT.md)** - Development workflow
|
|
|
|
---
|
|
|
|
## 🎯 Supported Devices
|
|
|
|
| Platform | Sync | OPDS | Status |
|
|
| ---------------- | ---- | ---- | ------------------------ |
|
|
| **Web Browser** | ✅ | ✅ | Full support |
|
|
| **KOReader** | ✅ | ✅ | Kindle, Kobo, PocketBook |
|
|
| **Kobo Devices** | ✅ | ✅ | Clara, Libra, Sage, etc. |
|
|
| **Mobile Apps** | 🚧 | 🚧 | Coming Q2 2026 |
|
|
|
|
---
|
|
|
|
## 🛠 Tech Stack
|
|
|
|
- **Backend**: Go 1.25+ with Echo framework
|
|
- **Database**: PostgreSQL 15+ with pgx v5
|
|
- **Frontend**: HTMX + Tailwind CSS + Templ
|
|
- **Auth**: JWT tokens with bcrypt password hashing
|
|
- **Container**: Podman (Docker compatible)
|
|
|
|
---
|
|
|
|
## 🧪 Testing
|
|
|
|
```bash
|
|
# Run all tests
|
|
make test-all
|
|
|
|
# Run integration tests (with test mode)
|
|
make test-integration
|
|
|
|
# Run Bruno OpenCollection YAML API tests
|
|
npm install -g @usebruno/cli
|
|
bruno run
|
|
```
|
|
|
|
---
|
|
|
|
## 📊 Project Status
|
|
|
|
**Version**: 1.0
|
|
**License**: GPL-3.0
|
|
**Status**: Production-ready ✅
|
|
|
|
---
|
|
|
|
## 🤝 Contributing
|
|
|
|
We welcome contributions! Please see [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) for guidelines.
|
|
|
|
---
|
|
|
|
## 📄 License
|
|
|
|
GPL-3.0 - See [LICENSE](LICENSE) file for details.
|
|
|
|
---
|
|
|
|
**Built with ❤️ using Go, PostgreSQL, HTMX, and Tailwind CSS**
|