X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fcustomservices.md;h=5bb08ff06b59cb8e4d58f212d20a4ce336cc04c9;hb=98fe0a393970070fa04b5f37dbbb7a4c3ef82beb;hp=b81094ebd44d56ac89d487c12c09a90732353888;hpb=b5048fc353db26186563bb2b1319941b5c11a54a;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/docs/customservices.md b/docs/customservices.md index b81094e..5bb08ff 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -28,6 +28,9 @@ within Homer: - [rTorrent](#rtorrent) - [qBittorrent](#qbittorrent) - [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. @@ -270,6 +273,7 @@ servers can be found at https://enable-cors.org/server.html. torrentInterval: 60000 # Interval for updating the torrent count. username: "username" # Username for logging into rTorrent (if applicable). password: "password" # Password for logging into rTorrent (if applicable). +``` ## Proxmox @@ -344,3 +348,32 @@ Configuration example: ## SpeedtestTracker For the SpeedtestTracker service you just need to define a entry with type `SpeedtestTracker`. + +## What's up Docker + +What's up Docker allow to display info about the number of container running and the number for which an update is available on your Homer dashboard. + +The following configuration is available for the WUD service. + +```yaml +- name: "What's Up Docker" + logo: "assets/tools/sample.png" + subtitle: "Docker image update notifier" + 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 +```