aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/customservices.md
diff options
context:
space:
mode:
authorMatt Bentley <mbentley@mbentley.net>2022-11-19 10:14:22 -0500
committerGitHub <noreply@github.com>2022-11-19 07:14:22 -0800
commit98fe0a393970070fa04b5f37dbbb7a4c3ef82beb (patch)
tree23750120d98818d037e5f52f44a07f5a3f1debcb /docs/customservices.md
parentf62972f65932a486ec0355cd61df3372fca371f3 (diff)
downloadhomer-98fe0a393970070fa04b5f37dbbb7a4c3ef82beb.tar.gz
homer-98fe0a393970070fa04b5f37dbbb7a4c3ef82beb.tar.zst
homer-98fe0a393970070fa04b5f37dbbb7a4c3ef82beb.zip
Adds SABnzbd custom service; fixes #494 (#555)
* Adds SABnzbd custom service; fixes #494
Diffstat (limited to 'docs/customservices.md')
-rw-r--r--docs/customservices.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index 7448a8c..5bb08ff 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -30,6 +30,7 @@ within Homer:
30 - [CopyToClipboard](#copy-to-clipboard) 30 - [CopyToClipboard](#copy-to-clipboard)
31 - [Speedtest Tracker](#SpeedtestTracker) 31 - [Speedtest Tracker](#SpeedtestTracker)
32 - [What's Up Docker](#whats-up-docker) 32 - [What's Up Docker](#whats-up-docker)
33 - [SABnzbd](#sabnzbd)
33 34
34If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 35If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
35 36
@@ -361,3 +362,18 @@ The following configuration is available for the WUD service.
361 url: "http://192.168.1.12:3001" 362 url: "http://192.168.1.12:3001"
362 type: "WUD" 363 type: "WUD"
363``` 364```
365
366## SABnzbd
367
368The SABnzbd service can allow you to show the number of currently active
369downloads on your SABnzbd instance. An API key is required, and can be obtained from
370the "Config" > "General" section of the SABnzbd config in the SABnzbd web UI.
371
372```yaml
373- name: "SABnzbd"
374 logo: "assets/tools/sample.png"
375 url: "http://192.168.0.151:8080"
376 type: "SABnzbd"
377 apikey: "MY-SUPER-SECRET-API-KEY"
378 downloadInterval: 5000 # (Optional) Interval (in ms) for updating the download count
379```