- [rTorrent](#rtorrent)
- [qBittorrent](#qbittorrent)
- [CopyToClipboard](#copy-to-clipboard)
+ - [Speedtest Tracker](#SpeedtestTracker)
+ - [What's Up Docker](#whats-up-docker)
+ - [SABnzbd](#sabnzbd)
+ - [OctoPrint](#sabnzbd)
If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
```yaml
type: "Medusa"
- apikey: "01234deb70424befb1f4ef6a23456789"
+ apikey: "<---insert-api-key-here--->"
```
The url must be the root url of Medusa application.
```yaml
type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
- apikey: "01234deb70424befb1f4ef6a23456789"
+ apikey: "<---insert-api-key-here--->"
```
The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
- name: "Radarr"
type: "Radarr"
url: "http://localhost:7878/"
- apikey: "MY-SUPER-SECRET-API-KEY"
+ apikey: "<---insert-api-key-here--->"
target: "_blank"
legacyApi: true
```
```yaml
type: "PaperlessNG"
- apikey: "0123456789abcdef123456789abcdef"
+ apikey: "<---insert-api-key-here--->"
```
API key can be generated in Settings > Administration > Auth Tokens
This service displays info about the total number of containers managed by your Portainer instance.
In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
it to the apikey field.
-By default, every connected environments will be checked. To select specific ones,add an "environments" entry which can be a simple string or an array containing all the selected environments name.
+By default, every connected environments will be checked. To select specific ones, add an "environments" entry which can be a simple string or an array containing all the selected environments name.
See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
logo: "assets/tools/sample.png"
url: "http://192.168.0.151/"
type: "Portainer"
- apikey: "MY-SUPER-SECRET-API-KEY"
+ apikey: "<---insert-api-key-here--->"
# environments:
# - "raspberry"
# - "local"
logo: "assets/tools/sample.png"
url: "http://192.168.0.151/"
type: "Emby"
- apikey: "MY-SUPER-SECRET-API-KEY"
+ apikey: "<---insert-api-key-here--->"
libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
```
logo: "assets/tools/sample.png"
url: "http://192.168.0.151:8181"
type: "Tautulli"
- apikey: "MY-SUPER-SECRET-API-KEY"
+ apikey: "<---insert-api-key-here--->"
```
Because the service type and link don't necessarily have to match, you could
url: "http://192.168.0.151:32400/web" # Plex
endpoint: "http://192.168.0.151:8181" # Tautulli
type: "Tautulli"
- apikey: "MY-SUPER-SECRET-API-KEY"
+ apikey: "<---insert-api-key-here--->"
```
## Mealie
```yaml
type: "Healthchecks"
- apikey: "01234deb70424befb1f4ef6a23456789"
+ apikey: "<---insert-api-key-here--->"
```
The url must be the root url of the Healthchecks application.
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
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
+ hide: [] # hides information. Possible values are "vms", "vms_total", "lxcs", "lxcs_total", "disk", "mem" and "cpu".
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)
```
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
+```
+
+## OctoPrint
+
+The OctoPrint service only needs an `apikey` & `url` and optionally a `display` option.
+
+```yaml
+- name: "Octoprint"
+ logo: "https://cdn-icons-png.flaticon.com/512/3112/3112529.png"
+ apikey: "xxxxxxxxxxxx" # insert your own API key here. Request one from https://openweathermap.org/api.
+ url: "http://192.168.0.151:8080"
+ display: "text" # 'text' or 'bar'. Default to `text`.
+ type: "OctoPrint"
+```
\ No newline at end of file
projects / github / bastienwirtz / homer.git / blobdiff