mirror of https://github.com/kikootwo/ReadMeABook.git synced 2026-06-02 20:30:10 +00:00

Files

T

Claude 5a9b6b4b46 Add comprehensive OIDC access control and admin role mapping

Implements full OIDC configuration UI and backend support for access control and admin permissions.

**Access Control Features:**
- Open access (anyone can log in)
- Group/claim based access (require specific group membership)
- Allowed list (whitelist specific emails/usernames)
- Admin approval (manual approval required for new users)

**Admin Role Mapping:**
- Automatic admin role assignment based on OIDC claims
- Configurable claim name and value (default: groups claim)
- First user always becomes admin
- Dynamic role updates on each login

**Setup Wizard:**
- Updated OIDCConfigStep with comprehensive OIDC settings
- Access control method selector with conditional fields
- Admin role mapping configuration with examples
- Improved UX with clear sections and helpful descriptions

**Admin Settings:**
- Expanded OIDC section with all new configuration options
- Proper JSON array handling for allowed emails/usernames
- Visual organization matching setup wizard

**Backend:**
- Updated setup complete API to persist new OIDC fields
- Updated OIDC settings API for all new configuration
- Updated settings GET endpoint to return new fields with defaults
- Proper comma-separated to JSON array conversion

**Documentation:**
- Comprehensive OIDC section in auth.md
- Configuration examples and use cases
- Clear distinction between access control and admin roles
- Default values documented

All changes tested and ready for production use.

2026-01-28 11:41:56 -05:00

README.md

ReadMeABook - Audiobook Library Management

Status: MVP Complete (Phases 1-4 ✅) | Docker deployment pending

Stack

Frontend: Next.js 14+, TypeScript, Tailwind CSS
Backend: Node.js/Express via Next.js API routes
Database: PostgreSQL (Docker embedded)
Queue: Bull + Redis (Docker embedded)
Deployment: Single Docker image

Architecture

Docker Container
├── Next.js App (Frontend + Backend)
├── PostgreSQL (users, audiobooks, requests, config, jobs)
├── Bull Queue + Redis (background jobs)
└── Volumes: /config, /downloads, /media

External integrations: Plex (auth + library), Prowlarr/Jackett (indexers), qBittorrent/Transmission (downloads), Audible (metadata scraping)

Core Features (Implemented)

Plex OAuth authentication
Setup wizard (8 steps: admin, Plex, Prowlarr, download client, paths)
Audiobook discovery (popular, new releases via Audible scraping)
Request management with status tracking
Automation pipeline: search → download → organize → Plex scan
Admin dashboard with metrics, active downloads, recent requests
Settings pages (Plex, Prowlarr, download client, paths)
Scheduled jobs (Plex scan, Audible refresh, retry logic, cleanup)
User/admin RBAC

User Flow

Login with Plex → 2. Search/browse audiobooks → 3. Request → 4. Auto: search indexers → download torrent → organize files → scan Plex → 5. Available in Plex library

Documentation Map

Backend:

database.md - PostgreSQL schema, Prisma ORM
services/auth.md - Plex OAuth, JWT sessions
services/config.md - Settings storage, encryption
services/jobs.md - Bull queue, background processors
services/scheduler.md - Recurring jobs (cron)

Integrations:

integrations/plex.md - Library scanning, OAuth, matching
integrations/audible.md - Web scraping, metadata

Automation (Phase 3):

phase3/README.md - Automation pipeline overview
phase3/qbittorrent.md - Download client integration
phase3/prowlarr.md - Indexer search
phase3/ranking-algorithm.md - Torrent selection
phase3/file-organization.md - File management, seeding

Frontend:

frontend/components.md - React components catalog
frontend/routing-auth.md - Route protection, auth flow
frontend/pages/login.md - Login page design

Admin:

admin-dashboard.md - Metrics, monitoring
settings-pages.md - Configuration UI
setup-wizard.md - First-time setup flow

Deployment:

deployment/docker.md - Docker Compose, volumes, env vars

Development Phases

✅ Phase 1: Foundation (auth, database, setup wizard) ✅ Phase 2: User features (discovery, requests, dashboard) ✅ Phase 3: Automation (search, download, organize, Plex integration) ✅ Phase 4: Admin tools (dashboard, settings, monitoring, scheduled jobs) ⏳ Phase 5: Enhanced features (WebSockets, advanced search) ⏳ Phase 6: Advanced admin (analytics, notifications, quality profiles)

Standards

Files ≤400 lines
File headers link to documentation
Update docs before/after code changes
Type-safe TypeScript throughout
Encrypted sensitive config (AES-256)