diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/customservices.md | 56 |
1 files changed, 39 insertions, 17 deletions
diff --git a/docs/customservices.md b/docs/customservices.md index 3c4f5ad..e84afdb 100644 --- a/docs/customservices.md +++ b/docs/customservices.md | |||
@@ -7,24 +7,27 @@ if your homer instance is secured behind some form of authentication or access r | |||
7 | 7 | ||
8 | Available services are in `src/components/`. Here is an overview of all custom services that are available | 8 | Available services are in `src/components/`. Here is an overview of all custom services that are available |
9 | within Homer: | 9 | within Homer: |
10 | + [PiHole](#pihole) | ||
11 | + [OpenWeatherMap](#openweathermap) | ||
12 | + [Medusa](#medusa) | ||
13 | + [Lidarr, Prowlarr, Sonarr and Radarr](#lidarr-prowlarr-sonarr-and-radarr) | ||
14 | + [PaperlessNG](#paperlessng) | ||
15 | + [Ping](#ping) | ||
16 | + [Prometheus](#prometheus) | ||
17 | + [AdGuard Home](#adguard-home) | ||
18 | + [Portainer](#portainer) | ||
19 | + [Emby / Jellyfin](#emby--jellyfin) | ||
20 | + [Uptime Kuma](#uptime-kuma) | ||
21 | + [Tautulli](#tautulli) | ||
22 | + [Mealie](#mealie) | ||
23 | + [Healthchecks](#healthchecks) | ||
24 | + [Proxmox](#proxmox) | ||
25 | 10 | ||
26 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. | 11 | - [Custom Services](#custom-services) |
12 | - [Common options](#common-options) | ||
13 | - [PiHole](#pihole) | ||
14 | - [OpenWeatherMap](#openweathermap) | ||
15 | - [Medusa](#medusa) | ||
16 | - [Lidarr, Prowlarr, Sonarr and Radarr](#lidarr-prowlarr-sonarr-and-radarr) | ||
17 | - [PaperlessNG](#paperlessng) | ||
18 | - [Ping](#ping) | ||
19 | - [Prometheus](#prometheus) | ||
20 | - [AdGuard Home](#adguard-home) | ||
21 | - [Portainer](#portainer) | ||
22 | - [Emby / Jellyfin](#emby--jellyfin) | ||
23 | - [Uptime Kuma](#uptime-kuma) | ||
24 | - [Tautulli](#tautulli) | ||
25 | - [Mealie](#mealie) | ||
26 | - [Healthchecks](#healthchecks) | ||
27 | - [Proxmox](#proxmox) | ||
28 | - [qBittorrent](#qbittorrent) | ||
27 | 29 | ||
30 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. | ||
28 | 31 | ||
29 | ## Common options | 32 | ## Common options |
30 | 33 | ||
@@ -272,4 +275,23 @@ Configuration example: | |||
272 | warning_value: 50 | 275 | warning_value: 50 |
273 | danger_value: 80 | 276 | danger_value: 80 |
274 | api_token: "PVEAPIToken=root@pam!your-api-token-name=your-api-token-key" | 277 | api_token: "PVEAPIToken=root@pam!your-api-token-name=your-api-token-key" |
275 | ``` \ No newline at end of file | 278 | ``` |
279 | |||
280 | ## qBittorrent | ||
281 | |||
282 | This service displays the global upload and download rates, as well as the number of torrents | ||
283 | listed. The service communicates with the qBittorrent API interface which needs | ||
284 | to be accessible from the browser. Please consult | ||
285 | [the instructions](https://github.com/qbittorrent/qBittorrent/pull/12579) | ||
286 | for setting up qBittorrent and make sure the correct CORS-settings are applied. Examples for various | ||
287 | servers can be found at [enable-cors.org](https://enable-cors.org/server.html). | ||
288 | |||
289 | ```yaml | ||
290 | - name: "qBittorrent" | ||
291 | logo: "assets/tools/sample.png" | ||
292 | url: "http://192.168.1.2:8080" # Your rTorrent web UI, f.e. ruTorrent or Flood. | ||
293 | type: "qBittorrent" | ||
294 | rateInterval: 2000 # Interval for updating the download and upload rates. | ||
295 | torrentInterval: 5000 # Interval for updating the torrent count. | ||
296 | target: "_blank" # optional html a tag target attribute | ||
297 | ``` | ||