docs: bakery/homelab distribution, single-trunk CONTRIBUTING, drop leftover tarball
Some checks failed
check / check (push) Failing after 34s

State that breadarr is bakery-distributed (not in the BOS ISO, not a GTK
desktop-shell app, no bread events), add CONTRIBUTING.md for the
single-trunk + RC-tag model, ignore leftover src.tar.xz artifacts, and
delete breadarrd/src/src.tar.xz.
This commit is contained in:
Breadway 2026-08-15 21:35:31 +08:00
parent 3e566a193d
commit 73df2a4c3c
4 changed files with 106 additions and 0 deletions

View file

@ -5,6 +5,10 @@ A single-daemon Rust replacement for the Sonarr + Radarr + Prowlarr stack — on
- **`breadarrd`** — the daemon. Watches sources, matches releases to your library, scores and grabs candidates, imports completed downloads, probes them for real ground-truth quality, and refreshes Jellyfin. Runs as a `systemd --user` service.
- **`breadarr-tui`** — a terminal client (ratatui) that talks to `breadarrd`'s local HTTP API. No web UI, on purpose.
## Distribution
breadarr is a **homelab** product. It is distributed through bakery (`bakery install breadarr`) and is **not** baked into the BOS ISO. It is not a GTK/desktop-shell app, has no bos-settings panel, and does not subscribe to or emit bread events. bread's `KNOWN_APPS` list reserves the `"arr"` app id for a possible future integration; this repo does not emit on that id.
## Why this exists
Sonarr + Radarr + Prowlarr is three separate services, three databases, three web UIs, and a lot of setup surface for one workflow: watch for releases, pick the best one, download it, file it correctly, tell Jellyfin. breadarr collapses that into a single daemon, with a few specific problems solved directly rather than configured around:
@ -29,6 +33,8 @@ All three search-driven sources share one per-cycle request budget (default: 5 s
## Setup
Install via bakery (`bakery install breadarr`) on a homelab host, or build from this repo. breadarr is not on the BOS ISO.
1. Copy `config.example.toml` to `~/.config/breadarr/breadarrd.toml` and fill in:
- qBittorrent WebUI URL/credentials
- Jellyfin URL + API key