From 62d3cfe10c7d47c3bc397873b8a62a704e5fe7d7 Mon Sep 17 00:00:00 2001 From: Ignacio Tolstoy Date: Fri, 5 Jan 2024 20:14:54 +0100 Subject: [PATCH] Make pbe token creation more clear --- docs/widgets/services/proxmoxbackupserver.md | 24 ++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/widgets/services/proxmoxbackupserver.md b/docs/widgets/services/proxmoxbackupserver.md index 912e7440..21078aab 100644 --- a/docs/widgets/services/proxmoxbackupserver.md +++ b/docs/widgets/services/proxmoxbackupserver.md @@ -3,6 +3,30 @@ title: Proxmox Backup Server description: Proxmox Backup Server Widget Configuration --- + +You will need to generate an API Token for new or an existing user. Here is an example of how to do this for a new user. + +1. Navigate to the Proxmox Backup portal, click on Access Control +2. On the User Management tab, click the Add button + - User name: api-ro-user (or something informative) + - Realm: Proxmox Backup authentication + - Password: your choosing +3. Go to API Token tab and click on the Add button +4. Select the previously created user. +5. Set the name to something informative, like api-homepage +6. Go to Permissions tab and click on Add > User Permission + - Path: / + - User: user from bullet 2 above + - Role: Audit + - Propagated: checked +7. Click again on Add > Api Token Permission + - Path: / + - User: token from bullet 5 above + - Role: Audit + - Propagated: checked + +Use `username@pbs!Token ID` as the `username` (e.g `api-ro-user@pbs!api-homepage`) setting and `token` as the `password` setting. + Allowed fields: `["datastore_usage", "failed_tasks_24h", "cpu_usage", "memory_usage"]`. ```yaml