Reference material that does not fit in the README ’s overview. Each fact has one home; every other page links to it. This page is the map.
Doc Covers Settings reference Every sharerr.toml field, environment variable, and vault secret, plus backup, restore, and the [[peers]] recovery block. Compatibility What sharerr talks to today, how the three torrent clients differ, and what is deliberately left out, with the reason attached. The lighthouse Why the rendezvous service exists, its privacy property, and how to use or run one. The API The machine-facing HTTP contract (Torznab, Jackett, gossip, tracker, lighthouse, ops) and how it is generated. Dashboards A Grafana dashboard over /metrics, and Homepage and Home Assistant snippets over /dashboard. A Prowlarr definition A per-host Cardigann definition a friend installs in place of Generic Torznab, and why it cannot be one shared listing. Deploying The five compose layouts (each with its own README), what every one needs, exposing one port to several audiences, and gluetun’s key. Repo only. Support Where to ask for help, what to include in a request, and what to expect back. Security policy The threat model, what is in and out of scope, why the controls fit, and how to report a vulnerability.
Doc Covers Architecture The crate map, how a share moves end to end, trust boundaries, where state lives, and refactors weighed and declined. Design brief The original statement of intent, kept verbatim, and where the implementation disproved it. Alternatives How sharerr differs from acquisition/ratio automation (Autobrr, cross-seed) and from a shared or pooled *arr instance, and what it deliberately trades away.
Doc Covers Roadmap Where sharerr is going next: candidates weighed and firm intentions, smallest first. Contributing The verification loop, lint and test policy, MSRV, what CI runs, and how to submit a change. Testing The test tiers, the compose stacks they drive, fixtures, coverage, and mutation testing. CodeQL findings Each CodeQL finding resolved by more than an obvious fix: what the query flagged, why, and what changed. The compose test stacks The disposable stacks tier 2 runs against and how to drive them by hand. Repo only. Releasing The tag scheme, what a v* tag triggers, the release gates, and how to rehearse it. Governance Decision-making, roles, and continuity for a single-maintainer project. Code of conduct Standards for participating in any project space. OpenSSF Best Practices Badge Every passing- and silver-level criterion, the answer, and the evidence.