From b354bd4fbcff906aa272a5da5e324e5b4a9990ee Mon Sep 17 00:00:00 2001 From: "courtmanr@gmail.com" Date: Sun, 27 Apr 2025 20:35:31 +0100 Subject: [PATCH] docs: Clarify Proxmox API token permission requirements Explicitly state that the PVEAuditor role needs to be assigned to both the user AND the API token itself in Proxmox for Pulse to function correctly. Ref: #56 --- README.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 088219bd1..2ca242722 100644 --- a/README.md +++ b/README.md @@ -81,13 +81,24 @@ An API token is recommended for connecting Pulse to Proxmox. * Click `Add`. * **Important:** Copy the displayed `Secret` value immediately and store it securely. It will only be shown once. -4. **Assign permissions** - * Go to `Datacenter` → `Permissions` → `Add` → `User Permission`. - * Path: `/` - * User: Select the user the token belongs to (e.g., "pulse-monitor@pam"). - * Role: `PVEAuditor` (provides read-only access). - * Ensure `Propagate` is checked. - * Click `Add`. +4. **Assign permissions (to both User and Token)** + * Go to `Datacenter` → `Permissions`. + * **First, add permission for the User:** + * Click `Add` → `User Permission`. + * Path: `/` + * User: Select the user you created (e.g., "pulse-monitor@pam"). + * Role: `PVEAuditor` (provides read-only access). + * Ensure `Propagate` is checked. + * Click `Add`. + * **Second, add permission for the API Token:** + * Click `Add` → `API Token Permission`. + * Path: `/` + * API Token: Select the token you created (e.g., "pulse-monitor@pam!pulse"). + * Role: `PVEAuditor`. + * Ensure `Propagate` is checked. + * Click `Add`. + + *Note: Assigning the `PVEAuditor` role at the root path (`/`) with `Propagate` checked is crucial for Pulse to discover and monitor all nodes, VMs, containers, and storage in your cluster.* 5. **Update your `server/.env` file** with the `Token ID` (which looks like `user@realm!tokenid`, e.g., `pulse-monitor@pam!pulse`) and the `Secret` you saved.