aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/customservices.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index 3f17abc..fb3f2a7 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -25,6 +25,7 @@ within Homer:
25 - [Mealie](#mealie) 25 - [Mealie](#mealie)
26 - [Healthchecks](#healthchecks) 26 - [Healthchecks](#healthchecks)
27 - [Proxmox](#proxmox) 27 - [Proxmox](#proxmox)
28 - [rTorrent](#rtorrent)
28 - [qBittorrent](#qbittorrent) 29 - [qBittorrent](#qbittorrent)
29 30
30If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 31If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
@@ -249,6 +250,27 @@ Two lines are needed in the config.yml :
249The url must be the root url of the Healthchecks application. 250The url must be the root url of the Healthchecks application.
250The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API. 251The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API.
251 252
253## rTorrent
254
255This service displays the global upload and download rates, as well as the number of torrents
256listed in rTorrent. The service communicates with the rTorrent XML-RPC interface which needs
257to be accessible from the browser. Please consult
258[the instructions](https://github.com/rakshasa/rtorrent-doc/blob/master/RPC-Setup-XMLRPC.md)
259for setting up rTorrent and make sure the correct CORS-settings are applied. Examples for various
260servers can be found at https://enable-cors.org/server.html.
261
262```yaml
263- name: "rTorrent"
264 logo: "assets/tools/sample.png"
265 url: "http://192.168.0.151" # Your rTorrent web UI, f.e. ruTorrent or Flood.
266 xmlrpc: "http://192.168.0.151:8081" # Reverse proxy for rTorrent's XML-RPC.
267 type: "Rtorrent"
268 rateInterval: 5000 # Interval for updating the download and upload rates.
269 torrentInterval: 60000 # Interval for updating the torrent count.
270 username: "username" # Username for logging into rTorrent (if applicable).
271 password: "password" # Password for logging into rTorrent (if applicable).
272
273
252## Proxmox 274## Proxmox
253 275
254This service displays status information of a Proxmox node (VMs running and disk, memory and cpu used). It uses the proxmox API and [API Tokens](https://pve.proxmox.com/pve-docs/pveum-plain.html) for authorization so you need to generate one to set in the yaml config. You can set it up in Proxmox under Permissions > API Tokens. You also need to know the realm the user of the API Token is assigned to (by default pam). 276This service displays status information of a Proxmox node (VMs running and disk, memory and cpu used). It uses the proxmox API and [API Tokens](https://pve.proxmox.com/pve-docs/pveum-plain.html) for authorization so you need to generate one to set in the yaml config. You can set it up in Proxmox under Permissions > API Tokens. You also need to know the realm the user of the API Token is assigned to (by default pam).