X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fcustomservices.md;h=5bb08ff06b59cb8e4d58f212d20a4ce336cc04c9;hb=98fe0a393970070fa04b5f37dbbb7a4c3ef82beb;hp=65f3d4ca3559a34b4e9fe2326e1f9d2b9cad9a5f;hpb=f72c0bc7811dc19499418371e08930747fe087dc;p=github%2Fbastienwirtz%2Fhomer.git

diff --git a/docs/customservices.md b/docs/customservices.md
index 65f3d4c..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
@@ -298,6 +302,11 @@ Configuration example:
   warning_value: 50
   danger_value: 80
   api_token: "PVEAPIToken=root@pam!your-api-token-name=your-api-token-key"
+  # values below this line are optional (default value are false/empty):
+  hide_decimals: true # removes decimals from stats values.
+  hide: ["vms", "vms_total", "lxcs", "lxcs_total", "disk", "mem", "cpu"] # hides values included in the array
+  small_font_on_small_screens: true # uses small font on small screens (like mobile)
+  small_font_on_desktop: true # uses small font on desktops (just in case you're showing much info)
 ```
 
 ## qBittorrent
@@ -335,3 +344,36 @@ Configuration example:
   type: "CopyToClipboard"
   clipboard: "this text will be copied to your clipboard"
 ```
+
+## 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
+```