kikootwo
9dd09ec836
Refactor ebook flow to support multiple sources (Anna's Archive direct downloads + Prowlarr indexer search) and unify handling with existing audiobook processors. Key changes: - search-ebook.processor: rewritten to try Anna's Archive first then fall back to indexer search, add Prowlarr grouping, ranking (rankEbookTorrents), and handlers to route results to direct-download or download-torrent flows. - organize-files.processor: enriches audiobook/ebook metadata from AudibleCache (year, narrator), treats indexer downloads specially (seed retention), adds optional NZB cleanup/archive logic, and improves retryable error detection. - file-organizer: organizeEbook now accepts additional metadata and an isIndexerDownload flag and supports directories vs single-file paths. - API/UI: include request.type in admin requests API and remove the “coming soon” notice from Ebook settings tab. - fetch-ebook route: removed blocking error for indexer-only mode so the flow can proceed when indexer search is enabled. - Documentation: update TOC, ebook-sidecar, settings-pages, and ranking-algorithm docs to describe indexer search, unified ebook ranking, configuration, and flows. These changes enable indexer-based ebook discovery, ranking, and downloads while preserving existing Anna's Archive behavior and reusing audiobook download processors where possible.
13 KiB
Documentation Table of Contents
Purpose: Quick navigation for AI to locate relevant documentation without reading all files.
Authentication & Users
- Plex OAuth, JWT sessions, RBAC → backend/services/auth.md
- Local admin authentication, password change → backend/services/auth.md
- Route protection, auth guards → frontend/routing-auth.md
- Login page UI/UX → frontend/pages/login.md
Configuration & Setup
- First-time setup wizard → setup-wizard.md
- Settings management, encryption → backend/services/config.md
- Settings UI (modular architecture, all tabs) → settings-pages.md
- Settings architecture refactoring (Jan 2026) → settings-pages.md
- Audiobook organization templates → settings-pages.md, phase3/file-organization.md
- Setup middleware & status check → backend/middleware.md
- Environment variables, PUBLIC_URL, OAuth configuration → backend/services/environment.md
Database & Data Models
- PostgreSQL schema, tables, relationships → backend/database.md
- Prisma ORM, migrations → backend/database.md
Plex Integration
- OAuth, library scanning, fuzzy matching → integrations/plex.md
- Availability status, plexGuid linking → integrations/plex.md
Audiobookshelf Integration (PRD - Not Implemented)
- Full PRD, architecture, implementation phases → features/audiobookshelf-integration.md
- Step-by-step implementation guide → features/audiobookshelf-implementation-guide.md
- OIDC authentication (Authentik, Keycloak) → features/audiobookshelf-integration.md
- Manual user registration → features/audiobookshelf-integration.md
- Backend mode selection (Plex vs ABS) → features/audiobookshelf-integration.md
- Library service abstraction → features/audiobookshelf-integration.md
Audible Integration
- Web scraping (popular, new releases) → integrations/audible.md
- Database caching, real-time matching → integrations/audible.md
- Book covers API for login page → frontend/pages/login.md
E-book Support (First-Class)
- First-class ebook requests, separate tracking → integrations/ebook-sidecar.md
- Multi-source ebook downloads (Anna's Archive + Indexer Search) → integrations/ebook-sidecar.md
- Ebook indexer search (Prowlarr with ebook categories) → integrations/ebook-sidecar.md
- ASIN-based matching, format selection → integrations/ebook-sidecar.md
- Ebook ranking algorithm (unified with audiobooks) → phase3/ranking-algorithm.md
- Direct HTTP downloads from Anna's Archive → integrations/ebook-sidecar.md
- Ebook delete behavior (files only, torrents seed) → integrations/ebook-sidecar.md
- Ebook settings (3-section UI) → settings-pages.md
- Indexer categories (audiobook/ebook tabs) → settings-pages.md
Automation Pipeline
- Full pipeline overview → phase3/README.md
- Search via Prowlarr (torrents + NZBs) → phase3/prowlarr.md
- Torrent ranking/selection → phase3/ranking-algorithm.md
- Multi-download-client support (qBittorrent + SABnzbd) → phase3/download-clients.md
- qBittorrent integration (torrents) → phase3/qbittorrent.md
- SABnzbd integration (Usenet/NZB) → phase3/sabnzbd.md
- File organization, seeding → phase3/file-organization.md
- Chapter merging (auto-merge to M4B) → features/chapter-merging.md
Background Jobs
- Bull queue, processors, retry logic → backend/services/jobs.md
- Scheduled/recurring jobs (cron) → backend/services/scheduler.md
- Job types: search, download monitor, organize, Plex scan, cleanup, retries
Logging
- Centralized logging (RMABLogger) → backend/services/logging.md
- LOG_LEVEL configuration → backend/services/logging.md
- Job-aware database persistence → backend/services/logging.md
Notifications
- Notification backends (Discord, Pushover) → backend/services/notifications.md
- Event types, triggers, message formatting → backend/services/notifications.md
- Notification settings UI → settings-pages.md
Frontend Components
- Component catalog (cards, badges, forms) → frontend/components.md
- RequestCard, StatusBadge, ProgressBar → frontend/components.md
- Pages: home, search, requests, profile → frontend/components.md
BookDate (AI Recommendations)
- AI-powered recommendations, swipe interface → features/bookdate.md
- Configuration, OpenAI/Claude integration → features/bookdate.md
- Library scopes (full, rated, favorites) → features/bookdate.md
- Pick my favorites (book selection modal) → features/bookdate.md
- Setup wizard integration, settings → features/bookdate.md
- Card stack animations (3-card stack, swipe animations) → features/bookdate-animations.md
- Library thumbnail caching → features/library-thumbnail-cache.md
Admin Features
- Dashboard (metrics, downloads, requests) → admin-dashboard.md
- Jobs management UI → backend/services/scheduler.md
- Request deletion (soft delete, seeding awareness) → admin-features/request-deletion.md
- Request approval system, auto-approve settings → admin-features/request-approval.md
Fixes & Improvements
- File hash-based library matching (ABS) → fixes/file-hash-matching.md
- Accurate ASIN matching for RMAB-organized content → fixes/file-hash-matching.md
Deployment
- Docker Compose setup (multi-container) → deployment/docker.md
- Unified container (all-in-one) → deployment/unified.md
- Environment variables, volumes → deployment/docker.md
- Database setup (Prisma), migrations → deployment/docker.md
Testing
- Backend unit test framework, scripts testing.md
Feature-Specific Lookups
"How do I add a new audiobook?" → integrations/audible.md (scraping), phase3/README.md (automation) "How do I configure multiple download clients?" → phase3/download-clients.md "How do torrent downloads work?" → phase3/qbittorrent.md, backend/services/jobs.md "How do Usenet/NZB downloads work?" → phase3/sabnzbd.md, backend/services/jobs.md "Can I use both qBittorrent and SABnzbd?" → phase3/download-clients.md "How does Plex matching work?" → integrations/plex.md "How does e-book support work?" → integrations/ebook-sidecar.md "How do I enable e-book downloads?" → integrations/ebook-sidecar.md, settings-pages.md "How do I configure ebook sources (Anna's Archive vs Indexer)?" → settings-pages.md "How does ebook indexer search work?" → integrations/ebook-sidecar.md "How do I configure ebook categories per indexer?" → settings-pages.md "How does ebook ranking work?" → phase3/ranking-algorithm.md "What happens when I delete an ebook request?" → integrations/ebook-sidecar.md "Why do ebook requests have an orange badge?" → integrations/ebook-sidecar.md "How do scheduled jobs work?" → backend/services/scheduler.md "How do I configure external services?" → setup-wizard.md, settings-pages.md "What's the database schema?" → backend/database.md "How does authentication work?" → backend/services/auth.md "How do I change my password?" → backend/services/auth.md (local users only - accessed via user menu in header) "How do I delete requests?" → admin-features/request-deletion.md "How do I approve/deny user requests?" → admin-features/request-approval.md "How do I enable auto-approve for requests?" → admin-features/request-approval.md "How do I customize audiobook folder organization?" → settings-pages.md, phase3/file-organization.md "How do I deploy?" → deployment/docker.md (multi-container), deployment/unified.md (all-in-one) "How do I use the unified container?" → deployment/unified.md "OAuth redirects to localhost / PUBLIC_URL not working" → backend/services/environment.md "What environment variables do I need?" → backend/services/environment.md "How does chapter merging work?" → features/chapter-merging.md "How does logging work?" → backend/services/logging.md "How do BookDate card stack animations work?" → features/bookdate-animations.md "How does Audiobookshelf integration work?" → features/audiobookshelf-integration.md (PRD only, not implemented) "How do I use OIDC/Authentik/Keycloak?" → features/audiobookshelf-integration.md (PRD only, not implemented) "How does manual user registration work?" → features/audiobookshelf-integration.md (PRD only, not implemented) "How do I switch from Plex to Audiobookshelf?" → features/audiobookshelf-integration.md (PRD only, not implemented) "How does library thumbnail caching work?" → features/library-thumbnail-cache.md "Why do BookDate library books show placeholders?" → features/library-thumbnail-cache.md "How does file hash matching work?" → fixes/file-hash-matching.md "Why is ABS matching the wrong book?" → fixes/file-hash-matching.md (file hash prevents false positives)