You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/customservices.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,6 +80,7 @@ Available services are located in `src/components/`:
80
80
endpoint: https://my-service-api.url # Optional: alternative base URL used to fetch service data when necessary.
81
81
useCredentials: false # Optional: Override global proxy.useCredentials configuration.
82
82
headers: # Optional: Override global proxy.headers configuration.
83
+
autoUpdateInterval: # Optional: Time in ms. Some services can periodically fetch data (see below)
83
84
```
84
85
85
86
If a subtitle is provided, (using the `subtitle` configuration key), **it will override (hide)** any custom information displayed on the subtitle line by the custom integration.
@@ -156,10 +157,10 @@ The `libraryType` configuration let you choose which stats to show.
156
157
Displays unread article count and total subscriptions from your FreshRSS server.
157
158
158
159
```yaml
159
-
- name: "FreshRSS"
160
+
- name: "FreshRSS"
160
161
type: "FreshRSS"
161
162
url: https://my-service.url
162
-
updateInterval: 5000 # (Optional) Interval (in ms) for updating the stats
163
+
autoUpdateInterval: 5000 # (Optional) Interval (in ms) for updating the stats
163
164
username: "<---your-username--->"
164
165
password: "<---your-password--->"
165
166
```
@@ -182,7 +183,7 @@ Optionally, the results can be filtered to only include jobs in the defined grou
182
183
183
184
The status can be checked regularly by defining an update Interval in ms:
184
185
```yaml
185
-
updateInterval: 5000
186
+
autoUpdateInterval: 5000
186
187
```
187
188
188
189
The average times can be hidden (saves their calculation also) by setting the following:
@@ -321,7 +322,7 @@ Two lines are needed in the `config.yml`:
321
322
type: "Lidarr" # "Lidarr" "Prowlarr", "Radarr" or "Sonarr"
322
323
logo: "assets/tools/sample.png"
323
324
url: https://my-service.url
324
-
checkInterval: 5000 # (Optional) Interval (in ms) for updating the status
325
+
autoUpdateInterval: 5000 # (Optional) Interval (in ms) for updating the status
325
326
apikey: "<---insert-api-key-here--->"
326
327
```
327
328
@@ -503,7 +504,7 @@ Displays stats from your PiAlert server.
503
504
type: "PiAlert"
504
505
logo: "assets/tools/sample.png"
505
506
url: https://my-service.url
506
-
updateInterval: 5000 # (Optional) Interval (in ms) for updating the stats
507
+
autoUpdateInterval: 5000 # (Optional) Interval (in ms) for updating the stats
507
508
```
508
509
509
510
## PiHole
@@ -518,7 +519,7 @@ Displays info about your local PiHole instance right on your Homer dashboard.
518
519
# endpoint: "https://my-service-api.url" # optional, For v6 API, this is the base URL used to fetch Pi-hole data overwriting the url
519
520
apikey: "<---insert-api-key-here--->" # optional, needed if web interface is password protected
520
521
apiVersion: 5 # optional, defaults to 5. Use 6 if your PiHole instance uses API v6
521
-
checkInterval: 3000 # optional, defaults to 300000. interval in ms to check Pi-hole status
522
+
autoUpdateInterval: 3000 # optional, defaults to 300000. interval in ms to check Pi-hole status
522
523
```
523
524
524
525
**API Key**: Required only if Pi-hole web interface is password protected. Go to **Settings > API/Web Interface > Show API token**
@@ -543,7 +544,7 @@ Optionally, use `successCodes` to define which HTTP response status codes should
543
544
# successCodes: [200, 418] # Optional, default to all 2xx HTTP response status codes
544
545
# timeout: 500 # Timeout in ms before ping is aborted. Default 2000
545
546
# subtitle: "Bookmark example" # By default, request round trip time is displayed when subtitle is not set
546
-
# updateInterval: 5000 # (Optional) Interval (in ms) for updating ping status
547
+
# autoUpdateInterval: 5000 # (Optional) Interval (in ms) for updating ping status
547
548
```
548
549
549
550
## Plex
@@ -633,8 +634,7 @@ for setting up qBittorrent.
633
634
type: "qBittorrent"
634
635
logo: "assets/tools/sample.png"
635
636
url: https://my-service.url # Your rTorrent web UI, f.e. ruTorrent or Flood.
636
-
rateInterval: 2000 # Interval for updating the download and upload rates.
637
-
torrentInterval: 5000 # Interval for updating the torrent count.
637
+
autoUpdateInterval: 2000 # Interval for updating the download, upload rates & torrent count
638
638
```
639
639
640
640
## rTorrent
@@ -651,8 +651,7 @@ for setting up rTorrent.
651
651
logo: "assets/tools/sample.png"
652
652
url: "https://my-service.url" # Your rTorrent web UI, f.e. ruTorrent or Flood.
653
653
xmlrpc: "https://my-service.url:port" # Reverse proxy for rTorrent's XML-RPC.
654
-
rateInterval: 5000 # Interval for updating the download and upload rates.
655
-
torrentInterval: 60000 # Interval for updating the torrent count.
654
+
autoUpdateInterval: 5000 # Interval for updating the download, upload rates & torrent count.
656
655
username: "username" # Username for logging into rTorrent (if applicable).
657
656
password: "password" # Password for logging into rTorrent (if applicable).
658
657
```
@@ -667,7 +666,7 @@ Displays the number of currently active downloads on your SABnzbd instance.
667
666
logo: "assets/tools/sample.png"
668
667
url: https://my-service.url
669
668
apikey: "<---insert-api-key-here--->"
670
-
downloadInterval: 5000 # (Optional) Interval (in ms) for updating the download count
669
+
autoUpdateInterval: 5000 # (Optional) Interval (in ms) for updating the download count
671
670
```
672
671
673
672
**API Key**: An API key is required, and can be obtained from the "Config" > "General" section of the SABnzbd config in the web UI.
@@ -681,7 +680,7 @@ Displays info about the total number of disk passed and failed S.M.A.R.T and scr
681
680
type: "Scrutiny"
682
681
logo: "assets/tools/sample.png"
683
682
url: https://my-service.url
684
-
updateInterval: 5000 # (Optional) Interval (in ms) for updating the status
683
+
autoUpdateInterval: 5000 # (Optional) Interval (in ms) for updating the status
685
684
```
686
685
687
686
## SpeedtestTracker
@@ -704,7 +703,7 @@ Displays the number of currently active streams on you Plex instance.
704
703
type: "Tautulli"
705
704
logo: "assets/tools/sample.png"
706
705
url: https://my-service.url
707
-
checkInterval: 5000 # (Optional) Interval (in ms) for updating the status
706
+
autoUpdateInterval: 5000 # (Optional) Interval (in ms) for updating the status
708
707
apikey: "<---insert-api-key-here--->"
709
708
```
710
709
@@ -732,7 +731,7 @@ Displays the number of currently queued items for transcoding on your Tdarr inst
732
731
type: "Tdarr"
733
732
logo: "assets/tools/sample.png"
734
733
url: https://my-service.url
735
-
checkInterval: 5000 # (Optional) Interval (in ms) for updating the queue & error counts
734
+
autoUpdateInterval: 5000 # (Optional) Interval (in ms) for updating the queue & error counts
736
735
```
737
736
738
737
## Traefik
@@ -760,7 +759,7 @@ The service communicates with the Transmission RPC interface which needs to be a
760
759
url: "http://192.168.1.2:9091" # Your Transmission web interface URL
0 commit comments