Adds SABnzbd custom service; fixes #494 (#555)

[github/bastienwirtz/homer.git] / docs / customservices.md

diff --git a/docs/customservices.md b/docs/customservices.md
index 7448a8c00b1071a9a08e0f6c9a847ee1d300a1f4..5bb08ff06b59cb8e4d58f212d20a4ce336cc04c9 100644 (file)
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -30,6 +30,7 @@ within Homer:
   - [CopyToClipboard](#copy-to-clipboard)
   - [Speedtest Tracker](#SpeedtestTracker)
   - [What's Up Docker](#whats-up-docker)
+  - [SABnzbd](#sabnzbd)
 
 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
 
@@ -361,3 +362,18 @@ The following configuration is available for the WUD service.
   url: "http://192.168.1.12:3001"
   type: "WUD"
 ```
+
+## SABnzbd
+
+The SABnzbd service can allow you to show the number of currently active
+downloads on your SABnzbd instance. An API key is required, and can be obtained from
+the "Config" > "General" section of the SABnzbd config in the SABnzbd web UI.
+
+```yaml
+- name: "SABnzbd"
+  logo: "assets/tools/sample.png"
+  url: "http://192.168.0.151:8080"
+  type: "SABnzbd"
+  apikey: "MY-SUPER-SECRET-API-KEY"
+  downloadInterval: 5000 # (Optional) Interval (in ms) for updating the download count
+```