-
Notifications
You must be signed in to change notification settings - Fork 70
Quality profiles
Quality profiles tell Bindery which file formats to accept and what the minimum acceptable quality is (the cutoff).
Bindery ships with three profiles created at first run:
| Name | Cutoff | Use case |
|---|---|---|
| Any | any | Accept whatever arrives first — useful if you just want the book |
| E-Book | epub | Accept any ebook format, but stop upgrading once an EPUB is on disk |
| Audiobook | audiobook | Dedicated profile for audiobook-only authors |
You assign a profile to each author when you add them (or change it later from the author detail page). All books under that author inherit the profile.
Bindery ranks formats from lowest to highest quality. When multiple results are available, the higher-ranked format wins:
| Rank | Format | Type |
|---|---|---|
| 0 | unknown | — |
| 1 | txt | Ebook |
| 2 | rtf | Ebook |
| 3 | Ebook | |
| 4 | mobi | Ebook |
| 5 | epub | Ebook |
| 6 | azw3 | Ebook |
| 7 | mp3 | Audiobook |
| 8 | m4a | Audiobook |
| 9 | m4b | Audiobook |
| 10 | flac | Audiobook |
The cutoff is the format at which Bindery stops looking for upgrades. Once a file at or above the cutoff is imported, the book is considered satisfied and no further grabs are attempted.
- Cutoff: epub — Bindery grabs whatever it finds first. If it later finds an EPUB (rank 5) or better and upgrades are allowed, it will replace a lower-quality file. Once an EPUB is on disk, no further upgrades happen.
- Cutoff: any — Any format satisfies the cutoff immediately; no upgrades are attempted once anything is imported.
If Upgrades allowed is checked on a profile, Bindery will replace an already-imported file if a higher-ranked format appears on your indexers. If it is off, the first successful import ends monitoring for that book.
Quality profiles are currently read-only in the UI. The three defaults cover most setups. Custom profiles (adding new entries or editing allowed/blocked items per format) are on the roadmap.
Getting started
Setup guides
How-to guides — proxy auth (v1.0)
How-to guides — OIDC (v1.0)
- Google Sign-In
- GitHub OAuth via Dex
- Authelia as OIDC provider
- Authentik
- Keycloak
- Rotate OIDC client secrets
- Recover from broken OIDC
How-to guides — multi-user (v1.0)
Reference
Contributing