- [Mealie](#mealie)
- [Healthchecks](#healthchecks)
- [Proxmox](#proxmox)
+ - [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.
The url must be the root url of the Healthchecks application.
The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API.
+## rTorrent
+
+This service displays the global upload and download rates, as well as the number of torrents
+listed in rTorrent. The service communicates with the rTorrent XML-RPC interface which needs
+to be accessible from the browser. Please consult
+[the instructions](https://github.com/rakshasa/rtorrent-doc/blob/master/RPC-Setup-XMLRPC.md)
+for setting up rTorrent and make sure the correct CORS-settings are applied. Examples for various
+servers can be found at https://enable-cors.org/server.html.
+
+```yaml
+- name: "rTorrent"
+ logo: "assets/tools/sample.png"
+ url: "http://192.168.0.151" # Your rTorrent web UI, f.e. ruTorrent or Flood.
+ xmlrpc: "http://192.168.0.151:8081" # Reverse proxy for rTorrent's XML-RPC.
+ type: "Rtorrent"
+ rateInterval: 5000 # Interval for updating the download and upload rates.
+ 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
This 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).
The API Token (or the user asigned to that token if not separated permissions is checked) are this:
| Path | Permission | Comments |
-| ------------------ | ---------- | |
+|--------------------|------------|-------------------------------------------------------------------|
| /nodes/<your-node> | Sys.Audit | |
| /vms/<id-vm> | VM.Audit | You need to have this permission on any VM you want to be counted |
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
torrentInterval: 5000 # Interval for updating the torrent count.
target: "_blank" # optional html a tag target attribute
```
+
+## Copy to Clipboard
+
+This service displays the same information of a generic one, but shows an icon button on the indicator place (right side) you can click to get the content of the `clipboard` field copied to your clipboard.
+
+You can still provide an `url` that would be open when clicked anywhere but on the icon button.
+
+Configuration example:
+
+```yaml
+- name: "Copy me!"
+ logo: "assets/tools/sample.png"
+ subtitle: "Subtitle text goes here"
+ url: "#"
+ 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
+```
projects / github / bastienwirtz / homer.git / blobdiff