Home

Bindery Wiki

Operational docs, recipes, and guides for Bindery — the automated book download manager for Usenet and torrents.

For installation and configuration reference, see docs/DEPLOYMENT.md in the main repo.

---

Getting started

Quickstart	First author to first grabbed book in 10 minutes
Migrating from Readarr	Import your Readarr database — what carries over, what doesn't, and what to do after

Setup guides

Indexer and downloader recipes	NZBGeek, DrunkenSlug, Prowlarr, Jackett, SABnzbd, NZBGet, qBittorrent, Transmission, Deluge — connection tips and category IDs
Prowlarr	Wire Prowlarr-managed indexers into Bindery via Newznab / Torznab — no dedicated Prowlarr type needed
Reverse proxy and SSO	Traefik, Caddy, Nginx — with optional Authelia / Authentik authentication
Calibre integration	Post-import sync via calibredb, drop-folder mode, and library import
OPDS	Browse and download your library from KOReader, Moon+ Reader, or any OPDS app

How-to guides

Step-by-step walkthroughs for common tasks.

Authentication — proxy auth (v1.0.0)

Set up Authelia forward-auth	Connect Authelia's forward-auth middleware so users sign in via Authelia and land in Bindery without a second login prompt
Set up Authentik forward-auth	Connect Authentik's embedded outpost so users sign in via Authentik and land in Bindery automatically
Troubleshoot a stuck proxy login	Systematic step-by-step diagnosis for 401, redirect loops, missing headers, and OPDS/script breakage

Authentication — OIDC (v1.0.0)

Set up Google Sign-In	Register a Google OAuth 2.0 client and add it as a Bindery OIDC provider
Set up GitHub OAuth	Wire GitHub → Dex → Bindery for GitHub-authenticated logins with stable user identity
Set up Authelia as OIDC provider	Use Authelia's native OIDC endpoint (vs Phase 1 forward-auth); includes group-based role mapping
Set up Authentik	Create an Authentik OAuth2/OIDC provider + application, navigate the per-app issuer URL gotcha, wire group claims
Set up Keycloak	Create a confidential Keycloak client, configure group mapper, connect to Bindery
Rotate OIDC client secrets	Safely rotate secrets at the IdP and update Bindery without disrupting existing sessions
Recover from broken OIDC config	Regain access, diagnose the failure, fix or remove the broken provider

Multi-user — v1.0.0

Migrate to multi-user mode	Backup, dry-run, and upgrade steps for migration 019 — a one-way door on SQLite
Add a second user	Create local, OIDC, and proxy-auth users; manage roles; delete users safely
Recover admin access	Regain admin when the last admin account is locked out, deleted, or forgotten
Use CSRF tokens in scripts	Add the CSRF preflight to session-cookie scripts, or migrate to API-key auth

Reference

Troubleshooting	Permission denied, path remapping, import failures, missing books
Quality profiles	Format preference order (EPUB / MOBI / AZW3 / PDF) and cutoff rules
Delay profiles	Hold off grabbing for N hours to let better releases appear
Custom formats	Regex-based scoring for RETAIL, freeleech, edition tags
Naming tokens	Template tokens ({Author}, {Title}, {ASIN}, {ext}, …) and sanitisation rules
Notifications	Send grab/import/failure events to ntfy, Slack, Discord, Home Assistant