Throttlearr
Docker app from allornothing's Repository
A gate that sits between Sonarr / Radarr / Lidarr / Readarr and SABnzbd.
Requirements
Overview
Readme
View on GitHubThrottlearr
A gate between your *arr apps and SABnzbd. Sonarr, Radarr, Lidarr and Readarr talk to Throttlearr as if it were SABnzbd. It holds the grabs in its own queue and hands them to the real SABnzbd only when your rules say there's room.
Why you'd want it:
- No more queue floods. One "search all missing" can dump thousands of jobs into SABnzbd. Throttlearr releases them gradually, oldest first, so the apps don't time out or re-grab.
- Bad releases get caught early. It looks inside the NZB first, and anything that's only a program, repair data or a sample clip is reported back as failed, so your app blocklists it and tries another.
- Easy to step around. One switch (fail open) passes everything straight through.
It doesn't download, search for or provide any content. It only controls the pace of work between your apps and your download client.
Image: allornothing/throttlearr · Source: aon082910/throttlearr
Install
Unraid: search Throttlearr in Apps. Anywhere else: use docker-compose.example.yml.
Then:
- Set
UPSTREAM_URLandUPSTREAM_API_KEYto your real SABnzbd. - Open
http://<server>:8085/and copy the API key under Connect your apps. - In Sonarr/Radarr, edit your SABnzbd download client to use Throttlearr's host, port and that key.
Tip: turn on Dry run first. Nothing is held, but the log shows what would have been.
Main settings
All settings are environment variables (template fields on Unraid). 0 means no limit.
| Variable | Default | What it does |
|---|---|---|
UPSTREAM_URL, UPSTREAM_API_KEY |
required | Your real SABnzbd |
MAX_ACTIVE |
3 |
Most jobs SABnzbd may hold at once |
MAX_ACTIVE_GB |
0 |
Cap on total GB still to download |
ADDS_PER_HOUR |
0 |
Cap on jobs sent per hour |
SCHEDULE |
any time | Allowed hours, e.g. mon-fri 21:00-07:00 |
MIN_FREE_GB |
0 |
Stop releasing when free space gets low |
PORT |
8085 |
Web page and API |
PUID / PGID |
99 / 100 |
File ownership |
More options (NZB checks, UI login, held-job timeout) are in the template. Health and Prometheus metrics are at /health and /metrics.
Help
Open an issue. MIT licensed.
Categories
Download Statistics
Related apps
Explore more like this
Explore allLinks
Details
allornothing/throttlearr:latestRuntime arguments
- Web UI
http://[IP]:[PORT:8085]/- Network
bridge- Shell
sh- Privileged
- false
Template configuration
Port for the web page and the SABnzbd-style API your apps connect to.
- Target
- 8085
- Default
- 8085
- Value
- 8085
Holds the database (held jobs, history, settings) and the held NZB files.
- Target
- /config
- Default
- /mnt/user/appdata/throttlearr
- Value
- /mnt/user/appdata/throttlearr
Address of your real SABnzbd, for example http://192.168.1.10:8080 (no trailing path).
- Target
- UPSTREAM_URL
- Default
- http://192.168.1.10:8080
- Value
- http://192.168.1.10:8080
SABnzbd's API key (SABnzbd, Config, General, API Key).
- Target
- UPSTREAM_API_KEY
Most jobs SABnzbd may hold at once, counting jobs Throttlearr did not add. 0 = no limit.
- Target
- MAX_ACTIVE
- Default
- 3
- Value
- 3
Optional cap on the total gigabytes still to download in SABnzbd. An empty SABnzbd always accepts one job, whatever its size. 0 = no limit.
- Target
- MAX_ACTIVE_GB
- Default
- 0
- Value
- 0
Optional. When jobs may be released, in the server's local time. Example: mon-fri 21:00-07:00; sat,sun 00:00-00:00 (an end before the start runs past midnight; 00:00-00:00 is the whole day). Empty = any time.
- Target
- SCHEDULE
The key Sonarr/Radarr use to talk to Throttlearr. Leave blank to have one generated; it is shown on the web page.
- Target
- API_KEY
Optional cap on jobs sent to SABnzbd per hour (some providers limit adds). 0 = no limit.
- Target
- ADDS_PER_HOUR
- Default
- 0
- Value
- 0
Optional. Stop releasing when free space would drop under this many GB. Needs the downloads folder mounted below. 0 = off.
- Target
- MIN_FREE_GB
- Default
- 0
- Value
- 0
Optional: the folder SABnzbd downloads into, read only. Only used to measure free space for the setting above.
- Target
- /downloads
A job held longer than this is dropped and reported to the app as failed, so it searches again. 0 = never.
- Target
- MAX_HELD_HOURS
- Default
- 72
- Value
- 72
Jobs sent with SABnzbd's Force priority are never held (true or false).
- Target
- BYPASS_FORCE
- Default
- true
- Value
- true
Optional: refuse an NZB whose video and archives add up to less than this many MB. 0 = off.
- Target
- MIN_NZB_MB
- Default
- 0
- Value
- 0
Optional. Set both user and password to put the web page behind a login. The API for your apps is not affected.
- Target
- UI_USER
Optional password for the web page.
- Target
- UI_PASSWORD
true = never hold anything, only log what would have been held. Good for a first try.
- Target
- DRY_RUN
- Default
- false
- Value
- false
Time zone for the allowed hours.
- Target
- TZ
- Default
- America/New_York
- Value
- America/New_York
User id the app runs as (Unraid: 99 = nobody).
- Default
- 99
- Value
- 99
Group id the app runs as (Unraid: 100 = users).
- Default
- 100
- Value
- 100