Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

Rename project documentation: Bookmann → Bookhoard

Browse Source 
Documentation updates:
- Update README.md title and all references
- Update PROJECT_GUIDELINES.md title and guidelines
- Update all documentation files in docs/ directory
- Update device setup guides (Kobo, KOReader)
- Update API and architecture documentation
- Update completion summaries and progress reports

This is part 5 of the project rename to Bookhoard.
This commit is contained in:
john-okeefe
2026-02-01 16:12:12 -05:00
parent 96825e3bc2
commit 67629b0c14
15 changed files with 184 additions and 184 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/devices/KOREADER_SETUP.md
+45 -45
View File
@@ -1,6 +1,6 @@
# KOReader Device Setup Guide
This guide will help you set up KOReader on your e-reader device to sync with Bookmann.
This guide will help you set up KOReader on your e-reader device to sync with Bookhoard.
## What is KOReader?
@@ -13,10 +13,10 @@ KOReader is an open-source e-reader application that supports a wide range of e-
## Prerequisites
Before you begin, make sure you have:
- ✅ A Bookmann instance running and accessible on your network
- ✅ Your Bookmann credentials (username and password)
- ✅ A Bookhoard instance running and accessible on your network
- ✅ Your Bookhoard credentials (username and password)
- ✅ A KOReader-compatible e-reader device
- ✅ Your device connected to the same Wi-Fi network as your Bookmann instance
- ✅ Your device connected to the same Wi-Fi network as your Bookhoard instance
## Installation
@@ -64,16 +64,16 @@ Before you begin, make sure you have:
## Device Registration
### Step 1: Get Your Bookmann Instance URL
### Step 1: Get Your Bookhoard Instance URL
Find your Bookmann instance URL. This will typically be one of:
Find your Bookhoard instance URL. This will typically be one of:
- **Local Network**: `http://YOUR_COMPUTER_IP:8765`
- **Localhost (if testing)**: `http://localhost:8765`
- **Domain (if configured)**: `https://bookmann.yourdomain.com`
### Step 2: Register Your Device in Bookmann
### Step 2: Register Your Device in Bookhoard
1. Log in to your Bookmann web interface
1. Log in to your Bookhoard web interface
2. Navigate to **Device Management** → **Add New Device**
3. Fill in the device details:
- **Device Name**: A friendly name (e.g., "My Kindle Paperwhite")
@@ -97,7 +97,7 @@ You'll receive:
2. **Method B: Manual URL**
- Copy the Auth URL from the registration confirmation
- Open it in your web browser
- Log in to your Bookmann account
- Log in to your Bookhoard account
- Click **Approve Device**
Your device is now registered and ready to sync!
@@ -113,7 +113,7 @@ Your device is now registered and ready to sync!
### Step 2: Configure Wireless Connection
1. **Enable Calibre Wireless Connection**: Toggle ON
2. **Server Address**: Enter your Bookmann instance URL
2. **Server Address**: Enter your Bookhoard instance URL
```
http://YOUR_COMPUTER_IP:8765/api/sync/koreader
```
@@ -124,8 +124,8 @@ Your device is now registered and ready to sync!
### Step 3: Configure Authentication
1. **Authentication Method**: Select "Basic Auth"
2. **Username**: Your Bookmann email or username
3. **Password**: Your Bookmann password
2. **Username**: Your Bookhoard email or username
3. **Password**: Your Bookhoard password
### Step 4: Configure Sync Settings
@@ -149,7 +149,7 @@ Your device is now registered and ready to sync!
3. If it fails:
- Verify your device is connected to Wi-Fi
- Check the server URL is correct
- Ensure your Bookmann instance is running
- Ensure your Bookhoard instance is running
- Verify username and password are correct
## Using Sync Features
@@ -157,7 +157,7 @@ Your device is now registered and ready to sync!
### Initial Sync
When you first enable sync, KOReader will:
1. Connect to Bookmann
1. Connect to Bookhoard
2. Upload your current reading progress
3. Download any annotations from the server
4. Set up bidirectional sync for future changes
@@ -216,7 +216,7 @@ Enable debug logging if sync isn't working:
### What is OPDS?
OPDS (Open Publication Distribution System) allows your KOReader device to **wirelessly download books** from Bookmann - no USB cable needed!
OPDS (Open Publication Distribution System) allows your KOReader device to **wirelessly download books** from Bookhoard - no USB cable needed!
### OPDS Benefits
@@ -230,7 +230,7 @@ OPDS (Open Publication Distribution System) allows your KOReader device to **wir
#### Step 1: Get Your OPDS URL
1. Log in to Bookmann web interface
1. Log in to Bookhoard web interface
2. Go to **Device Management**
3. Find your registered KOReader device
4. Click **Show OPDS URL**
@@ -242,17 +242,17 @@ OPDS (Open Publication Distribution System) allows your KOReader device to **wir
2. Tap the **+** (plus) button on the home screen
3. Select **OPDS Catalog**
4. Enter catalog details:
- **Name**: Bookmann (or any name you prefer)
- **Name**: Bookhoard (or any name you prefer)
- **URL**: Paste your OPDS URL from Step 1
5. Tap **Save**
Your Bookmann library now appears in KOReader's home screen!
Your Bookhoard library now appears in KOReader's home screen!
### Browse and Download Books
#### Browse Your Library
1. Tap **Bookmann** on KOReader home screen
1. Tap **Bookhoard** on KOReader home screen
2. You'll see:
- **All Books**: Complete library view
- **Collections**: Books organized by collections
@@ -269,7 +269,7 @@ Your Bookmann library now appears in KOReader's home screen!
#### Download Entire Collections
1. In Bookmann catalog, tap **Collections**
1. In Bookhoard catalog, tap **Collections**
2. Select a collection
3. Tap **Download All** to get all books
4. Downloads queue and process in background
@@ -291,12 +291,12 @@ KOReader OPDS supports:
Books downloaded via OPDS are automatically matched:
- Uses SHA-256 hashes for precise matching
- Falls back to title/author matching
- Links to your existing Bookmann library
- Links to your existing Bookhoard library
- Progress syncs automatically
#### Collection Integration
Your Bookmann collections appear in KOReader:
Your Bookhoard collections appear in KOReader:
- Collection **"To Read"** → KOReader category
- Collection **"Science Fiction"** → Browseable section
- Custom collections → Preserved organization
@@ -329,14 +329,14 @@ Automatically download new books from collections:
#### Catalog Not Loading
**Problem**: Bookmann catalog shows error or won't load
**Problem**: Bookhoard catalog shows error or won't load
**Solutions**:
1. Verify device is connected to Wi-Fi
2. Check OPDS URL is correct in settings
3. Try accessing OPDS URL in your browser
4. Ensure Bookmann server is running
5. Check Bookmann device is approved
4. Ensure Bookhoard server is running
5. Check Bookhoard device is approved
#### Download Fails
@@ -346,19 +346,19 @@ Automatically download new books from collections:
1. Check Wi-Fi signal strength
2. Ensure sufficient storage on device
3. Try downloading a smaller book
4. Check Bookmann has the book file
5. Review Bookmann logs for errors
4. Check Bookhoard has the book file
5. Review Bookhoard logs for errors
#### Book Opens But Progress Doesn't Sync
**Problem**: Downloaded book doesn't sync progress
**Solutions**:
1. Verify book is matched to Bookmann library
1. Verify book is matched to Bookhoard library
2. Check device sync settings are enabled
3. Try manual sync from device
4. Ensure book exists in Bookmann with same hash
5. Check Bookmann Progress page
4. Ensure book exists in Bookhoard with same hash
5. Check Bookhoard Progress page
#### Slow Downloads
@@ -384,9 +384,9 @@ OPDSUserAgent = "KOReader/2024.01"
#### Authentication Token
If Bookmann requires token authentication:
If Bookhoard requires token authentication:
1. Get token from Bookmann device settings
1. Get token from Bookhoard device settings
2. Add to OPDS URL: `?token=YOUR_TOKEN`
3. KOReader includes token in all requests
@@ -427,7 +427,7 @@ OPDSCompressionEnabled = true
**Problem**: "Connection refused" error
**Solutions**:
- Verify Bookmann is running on your computer
- Verify Bookhoard is running on your computer
- Check the server URL and port (8765)
- Ensure device is on same Wi-Fi network
- Try using your computer's IP address instead of "localhost"
@@ -439,26 +439,26 @@ OPDSCompressionEnabled = true
**Solutions**:
- Verify username and password
- Check your account is active and not locked
- Try logging in to Bookmann web interface first
- Try logging in to Bookhoard web interface first
- Reset password if needed
### Sync Not Working
**Problem**: Changes not appearing in Bookmann
**Problem**: Changes not appearing in Bookhoard
**Solutions**:
- Enable debug logging in KOReader
- Check Bookmann Device Management page for errors
- Check Bookhoard Device Management page for errors
- Verify sync is enabled in KOReader settings
- Try manual sync to trigger immediate update
- Check Bookmann logs for sync errors
- Check Bookhoard logs for sync errors
### Conflicts Detected
**Problem**: Sync conflicts when reading on multiple devices
**Solutions**:
1. Go to Bookmann **Conflicts** page
1. Go to Bookhoard **Conflicts** page
2. Review conflicting progress from each device
3. Choose which device's progress to keep
4. Set auto-resolution preference for future conflicts
@@ -468,15 +468,15 @@ OPDSCompressionEnabled = true
**Problem**: Large annotations or highlights fail to sync
**Solutions**:
- Check Bookmann sync queue for stuck items
- Check Bookhoard sync queue for stuck items
- Increase sync timeout in KOReader settings
- Break up large highlights into smaller segments
- Verify network bandwidth is sufficient
## Security Best Practices
1. **Use HTTPS**: If deploying Bookmann publicly, configure SSL/TLS
2. **Strong Password**: Use a secure password for your Bookmann account
1. **Use HTTPS**: If deploying Bookhoard publicly, configure SSL/TLS
2. **Strong Password**: Use a secure password for your Bookhoard account
3. **Network Security**: Ensure your Wi-Fi network is secure (WPA2/WPA3)
4. **Device Authorization**: Only approve devices you recognize
5. **Regular Updates**: Keep KOReader updated to the latest version
@@ -485,7 +485,7 @@ OPDSCompressionEnabled = true
- [KOReader Documentation](https://github.com/koreader/koreader)
- [KOReader Forum](https://www.mobileread.com/forums/forumdisplay.php?f=271)
- [Bookmann Universal Sync Guide](UNIVERSAL_SYNC_IMPLEMENTATION_GUIDE.md)
- [Bookhoard Universal Sync Guide](UNIVERSAL_SYNC_IMPLEMENTATION_GUIDE.md)
- [Kobo Setup Guide](KOBO_SETUP.md)
## Support
@@ -493,11 +493,11 @@ OPDSCompressionEnabled = true
If you encounter issues:
1. Check the troubleshooting section above
2. Enable debug logging and review KOReader logs
3. Check Bookmann sync queue and device management pages
4. Open an issue on the Bookmann GitHub repository
3. Check Bookhoard sync queue and device management pages
4. Open an issue on the Bookhoard GitHub repository
---
**Last Updated**: 2026-01-31
**Bookmann Version**: 1.0
**Bookhoard Version**: 1.0
**KOReader Version**: 2024.01+