]> git.immae.eu Git - github/bastienwirtz/homer.git/commitdiff
doc: documentation enchancement for SpeedtestTracker service
authorLindemberg Barbosa <lindembergdepaulo@gmail.com>
Fri, 22 Sep 2023 18:56:54 +0000 (15:56 -0300)
committerBastien Wirtz <bastien.wirtz@gmail.com>
Mon, 25 Sep 2023 18:10:17 +0000 (20:10 +0200)
docs/customservices.md

index 772a04af0eb1a64dc060246f6b86af52d8366584..47210fcf3b8f989ca13acf3e1d1acbf650d2f6f4 100644 (file)
@@ -356,7 +356,17 @@ Configuration example:
 
 ## SpeedtestTracker
 
-For the SpeedtestTracker service you just need to define a entry with type `SpeedtestTracker`.
+This SpeedtestTracker service will show the download and upload speeds in Mbit/s and the ping in ms.
+To configure this service, you need to define the url of SpeedtestTracker running and an entry with type `SpeedtestTracker`.
+
+Configuration example:
+
+```yaml
+- name: "Speedtest Tracker"
+  type: "SpeedtestTracker"
+  url: "http://192.168.0.1:8765"
+  target: "_blank"
+```
 
 ## What's up Docker