diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/customservices.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/customservices.md b/docs/customservices.md index df97cc9..67baed0 100644 --- a/docs/customservices.md +++ b/docs/customservices.md | |||
@@ -21,6 +21,7 @@ within Homer: | |||
21 | + [Tautulli](#tautulli) | 21 | + [Tautulli](#tautulli) |
22 | + [Mealie](#mealie) | 22 | + [Mealie](#mealie) |
23 | + [Healthchecks](#healthchecks) | 23 | + [Healthchecks](#healthchecks) |
24 | + [Proxmox](#proxmox) | ||
24 | 25 | ||
25 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. | 26 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. |
26 | 27 | ||
@@ -244,3 +245,20 @@ Two lines are needed in the config.yml : | |||
244 | 245 | ||
245 | The url must be the root url of the Healthchecks application. | 246 | The url must be the root url of the Healthchecks application. |
246 | The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API. | 247 | The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API. |
248 | |||
249 | ## Proxmox | ||
250 | |||
251 | 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). | ||
252 | |||
253 | Configuration example: | ||
254 | |||
255 | ```yaml | ||
256 | - name: "Proxmox - Node" | ||
257 | logo: "https://www.google.com/url?sa=i&url=https%3A%2F%2Fgithub.com%2FandOTP%2FandOTP%2Fissues%2F337&psig=AOvVaw2YKVuEUIBeTUikr7kAjm8D&ust=1665323538747000&source=images&cd=vfe&ved=0CAkQjRxqFwoTCPCTruLj0PoCFQAAAAAdAAAAABAN" | ||
258 | type: "Proxmox" | ||
259 | url: "https://your.proxmox.server" | ||
260 | node: "your-node-name" | ||
261 | warning_value: 50 | ||
262 | danger_value: 80 | ||
263 | api_token: "PVEAPIToken=root@pam!your-api-token-name=your-api-token-key" | ||
264 | ``` \ No newline at end of file | ||