docs: update references for new configuration structure
- Update README.md with simplified documentation links - Update docs/API_REFERENCE.md formatting and structure - Update docs/SYNC_USER_GUIDE.md with minor improvements These updates reflect the reorganized documentation structure and new configuration approach with defaults in docker-compose.yml.
This commit is contained in:
+67
-55
@@ -4,10 +4,11 @@
|
||||
1. [What is Universal Sync?](#what-is-universal-sync)
|
||||
2. [Supported Devices](#supported-devices)
|
||||
3. [Getting Started](#getting-started)
|
||||
4. [Device Registration](#device-registration)
|
||||
5. [Sync Features](#sync-features)
|
||||
6. [Troubleshooting](#troubleshooting)
|
||||
7. [Best Practices](#best-practices)
|
||||
4. [Device Setup](#device-setup)
|
||||
5. [Using Sync Features](#using-sync-features)
|
||||
6. [Book Matching](#book-matching)
|
||||
7. [Managing Conflicts](#managing-conflicts)
|
||||
8. [Best Practices](#best-practices)
|
||||
|
||||
---
|
||||
|
||||
@@ -61,72 +62,83 @@
|
||||
|
||||
### Quick Start
|
||||
|
||||
1. **Start Reading** - Open any book in the web interface or on your device
|
||||
2. **Turn Pages** - Progress syncs automatically
|
||||
3. **Switch Devices** - Pick up any other device - your progress is there!
|
||||
1. **Set up your first device** - See [Device Setup](#device-setup) below
|
||||
2. **Start reading** - Open any book in the web interface or on your device
|
||||
3. **Turn pages** - Progress syncs automatically
|
||||
4. **Switch devices** - Pick up any other device - your progress is there!
|
||||
|
||||
---
|
||||
|
||||
## Device Registration
|
||||
## Device Setup
|
||||
|
||||
### Step-by-Step Guide
|
||||
For detailed device configuration instructions, see the appropriate setup guide:
|
||||
|
||||
#### Option 1: Web-Based Registration (Recommended)
|
||||
- **[Kobo Setup Guide](devices/KOBO_SETUP.md)** - Kobo e-reader configuration
|
||||
- **[KOReader Setup Guide](devices/KOREADER_SETUP.md)** - KOReader configuration
|
||||
|
||||
1. **On Your Device**:
|
||||
- Open your reading app (KOReader/Kobo)
|
||||
- Navigate to sync settings
|
||||
- Find "Bookhoard Sync" or "Calibre Sync"
|
||||
- Copy your device identifier (hardware ID)
|
||||
### Quick Overview
|
||||
|
||||
2. **In Your Browser**:
|
||||
- Go to your Bookhoard server
|
||||
- Log in with your account
|
||||
- Navigate to **Settings → Devices**
|
||||
- Click **Register New Device**
|
||||
- Enter your device name and type
|
||||
- Click **Generate Registration**
|
||||
**Registration Process**:
|
||||
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!
|
||||
|
||||
3. **Complete Registration**:
|
||||
- Scan the QR code OR copy the registration URL
|
||||
- Visit the approval URL in your browser
|
||||
- Review device details and click **Approve**
|
||||
- Device will receive authentication token
|
||||
|
||||
4. **Configure Sync**:
|
||||
- Enter the sync URL provided (e.g., `https://bookhoard.example.com/api/sync/koreader`)
|
||||
- Enable auto-sync
|
||||
- Set sync frequency (recommended: Every page turn)
|
||||
|
||||
#### Option 2: Direct Device Registration
|
||||
|
||||
1. **From Your Device**:
|
||||
- Navigate to sync settings
|
||||
- Select "Bookhoard Sync"
|
||||
- Enter server URL: `https://bookhoard.example.com`
|
||||
- Click "Register Device"
|
||||
- Device will display registration code
|
||||
|
||||
2. **In Your Browser**:
|
||||
- Go to `https://bookhoard.example.com/devices/approve`
|
||||
- Enter registration code
|
||||
- Approve the device
|
||||
|
||||
### Device Management
|
||||
|
||||
**View Your Devices**:
|
||||
**Device Management**:
|
||||
```
|
||||
Settings → Devices
|
||||
```
|
||||
|
||||
**Manage Devices**:
|
||||
- **Rename**: Click device name → Edit
|
||||
- **Disable Sync**: Toggle "Sync Enabled"
|
||||
- **Remove Device**: Click "Delete" (revokes access immediately)
|
||||
You can:
|
||||
- View all your registered devices
|
||||
- See last sync time and status
|
||||
- Disable or remove devices
|
||||
- View unlinked books that need matching
|
||||
- Manage file aliases
|
||||
|
||||
---
|
||||
|
||||
## Sync Features
|
||||
## Book Matching
|
||||
|
||||
### What is Book Matching?
|
||||
|
||||
When devices sync books, Bookhoard tries to automatically match them using:
|
||||
- **SHA-256 hash** (most reliable) - Content-based fingerprint
|
||||
- **ISBN** - Standard book identifier
|
||||
- **UUID** - Unique identifier from EPUB metadata
|
||||
- **Title + Author** (fallback) - Last resort matching
|
||||
|
||||
### Unlinked Books
|
||||
|
||||
Sometimes a book on your device can't be automatically matched to your library. This happens when:
|
||||
- The book was side-loaded (not downloaded via Bookhoard)
|
||||
- The file format was converted (EPUB → KEPUB)
|
||||
- The metadata doesn't match exactly
|
||||
|
||||
### Viewing Unlinked Books
|
||||
|
||||
```
|
||||
Settings → Devices → Select Device → View Unlinked Books
|
||||
```
|
||||
|
||||
### Resolving Unlinked Books
|
||||
|
||||
1. **Auto-Link** - Automatically link books with 80%+ confidence
|
||||
2. **Get Suggestions** - Review potential matches before linking
|
||||
3. **Manual Link** - Choose the correct match yourself
|
||||
|
||||
### Book Matching Priority
|
||||
|
||||
1. **Bookhoard UUID** - 100% confidence
|
||||
2. **OPF UUID** - 95% confidence
|
||||
3. **SHA-256 hash** - 90% confidence
|
||||
4. **OPF identifier** - 85% confidence
|
||||
5. **ISBN/ASIN** - 80% confidence
|
||||
6. **Title + Author + File Size** - 50% confidence
|
||||
|
||||
---
|
||||
|
||||
## Managing Conflicts
|
||||
|
||||
### Reading Progress
|
||||
|
||||
|
||||
Reference in New Issue
Block a user