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/KOBO_SETUP.md
+60 -60
View File
@@ -1,10 +1,10 @@
# Kobo Device Setup Guide
This guide will help you set up your Kobo e-reader to sync with Bookmann for seamless cross-device reading progress synchronization.
This guide will help you set up your Kobo e-reader to sync with Bookhoard for seamless cross-device reading progress synchronization.
## What is Kobo Sync?
Bookmann implements a Kobo-compatible sync protocol that allows your Kobo device to:
Bookhoard implements a Kobo-compatible sync protocol that allows your Kobo device to:
- Sync reading progress across all your devices
- Sync highlights and bookmarks
- Sync reading statistics
@@ -14,14 +14,14 @@ Bookmann implements a Kobo-compatible sync protocol that allows your Kobo device
Before you begin, make sure you have:
- ✅ A Kobo e-reader device (Clara, Aura, Nia, Libra, Sage, Elipsa, etc.)
- ✅ 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)
- ✅ USB cable to connect your Kobo to your computer
- ✅ Your Kobo connected to the same Wi-Fi network as your Bookmann instance
- ✅ Your Kobo connected to the same Wi-Fi network as your Bookhoard instance
## Supported Kobo Devices
Bookmann supports all Kobo devices that use the standard Kobo sync protocol:
Bookhoard supports all Kobo devices that use the standard Kobo sync protocol:
- **Kobo Clara**: Clara 2E, Clara HD
- **Kobo Aura**: Aura, Aura H2O, Aura ONE, Aura Edition 2
- **Kobo Libra**: Libra 2, Libra H2O
@@ -42,9 +42,9 @@ Bookmann supports all Kobo devices that use the standard Kobo sync protocol:
4. Note your **Device Serial Number** (e.g., N1234567890123)
- This is your device identifier for registration
### 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 Kobo Clara")
@@ -66,7 +66,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 for configuration!
@@ -97,7 +97,7 @@ Your device is now registered and ready for configuration!
2. Navigate to `.kobo/Kobo/Kobo eReader.conf`
3. Open in a text editor
### Step 3: Add Bookmann Sync Configuration
### Step 3: Add Bookhoard Sync Configuration
Add the following section to the end of your `Kobo eReader.conf` file:
@@ -107,7 +107,7 @@ Add the following section to the end of your `Kobo eReader.conf` file:
KoboStoreSyncDisabled=true
[Sync]
# Bookmann Sync Configuration
# Bookhoard Sync Configuration
ServerURL=http://YOUR_COMPUTER_IP:8765/api/sync/kobo
AutoSyncEnabled=true
SyncFrequency=5
@@ -119,8 +119,8 @@ Password=YOUR_BOOKMANN_PASSWORD
**Replace the following with your actual values**:
- `YOUR_COMPUTER_IP`: Your computer's local IP address (e.g., 192.168.1.100)
- `YOUR_BOOKMANN_USERNAME`: Your Bookmann email or username
- `YOUR_BOOKMANN_PASSWORD`: Your Bookmann password
- `YOUR_BOOKMANN_USERNAME`: Your Bookhoard email or username
- `YOUR_BOOKMANN_PASSWORD`: Your Bookhoard password
**Example configuration:**
```ini
@@ -141,7 +141,7 @@ Password=securePassword123
### Step 5: Verify Sync on Kobo
1. After Kobo restarts, go to **Settings** → **Sync & Backup**
2. You should see "Bookmann" listed as a sync provider
2. You should see "Bookhoard" listed as a sync provider
3. Tap **Sync Now** to test the connection
4. If successful, you'll see a "Sync Complete" message
@@ -174,12 +174,12 @@ Kobo syncs:
### What is OPDS?
OPDS (Open Publication Distribution System) allows your Kobo to **wirelessly download books** from Bookmann - no USB cable needed!
OPDS (Open Publication Distribution System) allows your Kobo to **wirelessly download books** from Bookhoard - no USB cable needed!
### OPDS Benefits
- **No USB Required**: Download books directly to your Kobo over Wi-Fi
- **On-Demand Delivery**: Browse your Bookmann library from your Kobo
- **On-Demand Delivery**: Browse your Bookhoard library from your Kobo
- **Collection Support**: Download books from specific collections
- **Progress Tracking**: Books downloaded via OPDS sync progress automatically
- **Format Conversion**: Automatic EPUB to KEPUB conversion for better Kobo support
@@ -211,8 +211,8 @@ OPDSCatalogURL=http://YOUR_COMPUTER_IP:8765/opds/devices/YOUR_DEVICE_ID/catalog
```
4. Replace:
- `YOUR_COMPUTER_IP`: Your Bookmann server IP
- `YOUR_DEVICE_ID`: Your Kobo's device ID from Bookmann Device Management
- `YOUR_COMPUTER_IP`: Your Bookhoard server IP
- `YOUR_DEVICE_ID`: Your Kobo's device ID from Bookhoard Device Management
5. Save the file and safely eject your Kobo
@@ -220,14 +220,14 @@ OPDSCatalogURL=http://YOUR_COMPUTER_IP:8765/opds/devices/YOUR_DEVICE_ID/catalog
1. Wake your Kobo and connect to Wi-Fi
2. Go to **Home** → **Store** (or **Shop**)
3. You'll see **Bookmann** listed as a store
4. Tap to enter the Bookmann catalog
3. You'll see **Bookhoard** listed as a store
4. Tap to enter the Bookhoard catalog
### Browse and Download Books
#### Browse All Books
1. In the Bookmann catalog, you'll see all books from your library
1. In the Bookhoard catalog, you'll see all books from your library
2. Browse by:
- **Recently Added**: Latest books in your library
- **Collections**: Books organized by collections
@@ -244,7 +244,7 @@ OPDSCatalogURL=http://YOUR_COMPUTER_IP:8765/opds/devices/YOUR_DEVICE_ID/catalog
#### Download from Collections
1. In the Bookmann catalog, tap **Collections**
1. In the Bookhoard catalog, tap **Collections**
2. Select a collection (e.g., "Science Fiction")
3. Browse books in that collection
4. Tap to download individual books
@@ -259,34 +259,34 @@ Kobo OPDS supports:
- **KEPUB**: Kobo-optimized EPUB (better page turns, fonts)
- **PDF**: Fixed-layout documents
**Automatic Conversion**: Bookmann automatically converts EPUB to KEPUB on-the-fly for better Kobo experience.
**Automatic Conversion**: Bookhoard automatically converts EPUB to KEPUB on-the-fly for better Kobo experience.
#### Progress Sync
Books downloaded via OPDS automatically sync progress:
1. Download a book via OPDS
2. Start reading on your Kobo
3. Progress syncs to Bookmann automatically
3. Progress syncs to Bookhoard automatically
4. Continue reading on any other device!
#### Collection to Shelf Mapping
Bookmann maps your collections to Kobo shelves:
Bookhoard maps your collections to Kobo shelves:
- Collection **"Science Fiction"** → Kobo shelf **"Sci-Fi"**
- Collection **"To Read"** → Kobo shelf **"To Read"**
- Customizable in Bookmann Device Management
- Customizable in Bookhoard Device Management
### OPDS Troubleshooting
#### Catalog Not Appearing
**Problem**: Bookmann catalog doesn't show in Kobo store
**Problem**: Bookhoard catalog doesn't show in Kobo store
**Solutions**:
1. Verify OPDS URL is correct in config file
2. Check Kobo is connected to Wi-Fi
3. Try accessing OPDS URL in your browser
4. Ensure device ID matches Bookmann device ID
4. Ensure device ID matches Bookhoard device ID
5. Restart Kobo after editing config file
#### Download Fails
@@ -295,10 +295,10 @@ Bookmann maps your collections to Kobo shelves:
**Solutions**:
1. Check Wi-Fi signal strength
2. Ensure Bookmann server is running
3. Verify book file exists in Bookmann library
2. Ensure Bookhoard server is running
3. Verify book file exists in Bookhoard library
4. Try downloading a smaller book first
5. Check Bookmann logs for errors
5. Check Bookhoard logs for errors
#### Book Downloads But Won't Open
@@ -306,7 +306,7 @@ Bookmann maps your collections to Kobo shelves:
**Solutions**:
1. Verify book format is supported (EPUB/KEPUB/PDF)
2. Check file isn't corrupted in Bookmann
2. Check file isn't corrupted in Bookhoard
3. Try downloading via USB and opening
4. Check Kobo has sufficient free storage
5. Restart your Kobo device
@@ -339,7 +339,7 @@ Bookmann maps your collections to Kobo shelves:
#### Custom Catalog Name
Change the name of the Bookmann catalog on your Kobo:
Change the name of the Bookhoard catalog on your Kobo:
```ini
[OPDS]
@@ -367,7 +367,7 @@ PreferredFormat=kepub # Options: epub, kepub, auto
## Sync Frequency Options
Configure how often Kobo syncs with Bookmann:
Configure how often Kobo syncs with Bookhoard:
```ini
[Sync]
@@ -404,7 +404,7 @@ KoboStoreSyncDisabled=true
### Custom Sync URL
If you're running Bookmann with a custom domain or port:
If you're running Bookhoard with a custom domain or port:
```ini
[Sync]
@@ -420,7 +420,7 @@ ServerURL=http://localhost:8765/api/sync/kobo
### HTTPS Configuration
If you have SSL/TLS configured on Bookmann:
If you have SSL/TLS configured on Bookhoard:
```ini
[Sync]
@@ -440,18 +440,18 @@ Kobo will automatically trust the certificate if properly configured.
2. Verify `AutoSyncEnabled=true` in config
3. Check `SyncFrequency` is not set to 0
4. Test with manual sync first
5. Check Bookmann logs for connection attempts
5. Check Bookhoard logs for connection attempts
### Connection Refused
**Problem**: "Connection refused" or "Server not reachable"
**Solutions**:
1. Verify Bookmann is running on your computer
1. Verify Bookhoard is running on your computer
2. Check the server URL and IP address are correct
3. Ensure Kobo is on same Wi-Fi network as computer
4. Temporarily disable firewall to test
5. Try accessing Bookmann URL in your browser first
5. Try accessing Bookhoard URL in your browser first
### Authentication Failed
@@ -460,7 +460,7 @@ Kobo will automatically trust the certificate if properly configured.
**Solutions**:
1. Verify username and password in config file
2. Check your account is active and not locked
3. Try logging in to Bookmann web interface
3. Try logging in to Bookhoard web interface
4. Ensure password doesn't contain special characters that need escaping
5. Reset password if needed
@@ -484,17 +484,17 @@ Kobo will automatically trust the certificate if properly configured.
2. Check `SyncFrequency` is not 0
3. Kobo only syncs when connected to Wi-Fi
4. Some Kobo models require Wi-Fi to be manually connected
5. Check Bookmann device management page for connection errors
5. Check Bookhoard device management page for connection errors
### Books Not Appearing in Kobo
**Problem**: Books added to Bookmann don't show on Kobo
**Problem**: Books added to Bookhoard don't show on Kobo
**Solutions**:
1. Kobo needs books to be sideloaded (manually transferred via USB)
2. Bookmann syncs PROGRESS, not book files
2. Bookhoard syncs PROGRESS, not book files
3. Transfer book files to Kobo's `Documents` folder via USB
4. Kobo will then sync progress for those books with Bookmann
4. Kobo will then sync progress for those books with Bookhoard
5. Check that book formats are supported by Kobo
### Conflicts Not Showing
@@ -502,7 +502,7 @@ Kobo will automatically trust the certificate if properly configured.
**Problem**: Conflicts between devices aren't being detected
**Solutions**:
1. Check Bookmann Conflicts page
1. Check Bookhoard Conflicts page
2. Ensure both devices have synced recently
3. Conflicts only detected when progress differs within 5 minutes
4. Manually sync both devices to trigger conflict detection
@@ -510,8 +510,8 @@ Kobo will automatically trust the certificate if properly configured.
## 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. **Regular Updates**: Keep Kobo firmware updated
5. **Device Authorization**: Only approve devices you recognize
@@ -520,17 +520,17 @@ Kobo will automatically trust the certificate if properly configured.
### Local Network (Recommended)
For home use, keep Kobo and Bookmann on the same local network:
For home use, keep Kobo and Bookhoard on the same local network:
```
Kobo Wi-Fi: 192.168.1.x
Bookmann: 192.168.1.x
Bookhoard: 192.168.1.x
```
### Remote Access
For access outside your home network:
1. Set up port forwarding on your router (port 8765)
2. Configure SSL/TLS on Bookmann
2. Configure SSL/TLS on Bookhoard
3. Use a dynamic DNS service for constant hostname
4. Update Kobo config with public URL:
```ini
@@ -553,30 +553,30 @@ To extend Kobo battery life:
To improve sync speed:
1. Ensure strong Wi-Fi signal
2. Use local network (not remote access)
3. Keep Bookmann and Kobo on same network
3. Keep Bookhoard and Kobo on same network
4. Close other apps using Wi-Fi bandwidth
5. Reduce number of books syncing at once
## Additional Resources
- [Kobo Developer Documentation](https://help.kobo.com/hc/en-us)
- [Bookmann Universal Sync Guide](UNIVERSAL_SYNC_IMPLEMENTATION_GUIDE.md)
- [Bookhoard Universal Sync Guide](UNIVERSAL_SYNC_IMPLEMENTATION_GUIDE.md)
- [KOReader Setup Guide](KOBOREADER_SETUP.md)
- [Bookmann API Reference](API_REFERENCE.md)
- [Bookhoard API Reference](API_REFERENCE.md)
## FAQ
**Q: Can I sync books (files) between devices?**
A: No, Bookmann only syncs reading progress and annotations. You must sideload book files to each device manually.
A: No, Bookhoard only syncs reading progress and annotations. You must sideload book files to each device manually.
**Q: Will Kobo update automatically when I add books in Bookmann?**
A: No, Kobo doesn't fetch book files from Bookmann. You must transfer books via USB.
**Q: Will Kobo update automatically when I add books in Bookhoard?**
A: No, Kobo doesn't fetch book files from Bookhoard. You must transfer books via USB.
**Q: Can I use both Kobo Sync and Calibre?**
A: Yes, but they may conflict. It's recommended to choose one sync method.
**Q: What happens if I read the same book on Kobo and KOReader?**
A: Bookmann will detect conflicts and you can resolve them in the Conflicts UI.
A: Bookhoard will detect conflicts and you can resolve them in the Conflicts UI.
**Q: Does Kobo sync when in sleep mode?**
A: Only if Wi-Fi is enabled and configured to stay active during sleep.
@@ -586,12 +586,12 @@ A: Only if Wi-Fi is enabled and configured to stay active during sleep.
If you encounter issues:
1. Check the troubleshooting section above
2. Review Kobo sync logs in device settings
3. Check Bookmann sync queue and device management pages
3. Check Bookhoard sync queue and device management pages
4. Verify your configuration file is saved correctly
5. Open an issue on the Bookmann GitHub repository
5. Open an issue on the Bookhoard GitHub repository
---
**Last Updated**: 2026-01-31
**Bookmann Version**: 1.0
**Bookhoard Version**: 1.0
**Kobo Firmware**: 4.30.0+