aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/customservices.md
diff options
context:
space:
mode:
authorluixal <luixal@gmail.com>2022-10-11 19:00:53 +0200
committerBastien Wirtz <bastien.wirtz@gmail.com>2022-10-13 21:51:06 +0200
commit13069da195950d2598492ea9f4a8bb4585fcb71f (patch)
tree0f34b16c486bf43f7758139571f91781a0d81d21 /docs/customservices.md
parent0a03fcd9cd508514a6e2d5e3a6bb62bae6252331 (diff)
downloadhomer-13069da195950d2598492ea9f4a8bb4585fcb71f.tar.gz
homer-13069da195950d2598492ea9f4a8bb4585fcb71f.tar.zst
homer-13069da195950d2598492ea9f4a8bb4585fcb71f.zip
Adds loading and errors icons/msgs. Adds docs.
Diffstat (limited to 'docs/customservices.md')
-rw-r--r--docs/customservices.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index 67baed0..417459e 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -250,6 +250,17 @@ The Healthchecks API key can be found in Settings > API Access > API key (read-o
250 250
251This 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). 251This 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 252
253The API Token (or the user asigned to that token if not separated permissions is checked) are this:
254
255| Path | Permission | Comments |
256| ------------------ | ---------- | |
257| /nodes/<your-node> | Sys.Audit | |
258| /vms/<id-vm> | VM.Audit | You need to have this permission on any VM you want to be counted |
259
260It is highly recommended that you create and API Token with only these permissions on a read-only mode.
261
262If you get errors, they will be shown on browser's dev console. Main issues tend to be CORS related as Proxmox does not include CORS headers and you have to desploy it behind a reverse proxy and make the proxy add this headers.
263
253Configuration example: 264Configuration example:
254 265
255```yaml 266```yaml