Skip to content

Commit 0bd84a9

Browse files
committed
Docs: Update README to reflect multiple PBS instance support
1 parent 5c488a8 commit 0bd84a9

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -159,19 +159,28 @@ Optional numbered variables also exist (e.g., `PROXMOX_ALLOW_SELF_SIGNED_CERTS_2
159159
160160
#### Proxmox Backup Server (PBS) (Optional)
161161
162-
To monitor a PBS instance:
162+
To monitor PBS instances:
163163
164+
**Primary PBS Instance:**
164165
- `PBS_HOST`: URL of your PBS server (e.g., `https://192.168.1.11:8007`).
165166
- `PBS_TOKEN_ID`: Your PBS API Token ID (e.g., `user@pbs!tokenid`). See [Creating a Proxmox Backup Server API Token](#creating-a-proxmox-backup-server-api-token).
166167
- `PBS_TOKEN_SECRET`: Your PBS API Token Secret.
167168
- `PBS_NODE_NAME`: **Important!** The internal hostname of your PBS server (e.g., `pbs-server-01`). This is usually required for API token auth because the token might lack permission to auto-discover the node name. See details below.
168169
- `PBS_ALLOW_SELF_SIGNED_CERTS`: Set to `true` for self-signed certificates. Defaults to `false`.
169170
- `PBS_PORT`: PBS API port. Defaults to `8007`.
170171
171-
*Note: Currently, only one PBS instance can be configured.*
172+
**Additional PBS Instances:**
173+
174+
To monitor multiple PBS instances, add numbered variables, starting with `_2`:
175+
176+
- `PBS_HOST_2`, `PBS_TOKEN_ID_2`, `PBS_TOKEN_SECRET_2`
177+
- `PBS_HOST_3`, `PBS_TOKEN_ID_3`, `PBS_TOKEN_SECRET_3`
178+
- ...and so on.
179+
180+
Optional numbered variables also exist for additional PBS instances (e.g., `PBS_NODE_NAME_2`, `PBS_ALLOW_SELF_SIGNED_CERTS_2`, `PBS_PORT_2`). Each PBS instance, whether primary or additional, requires its respective `PBS_NODE_NAME` or `PBS_NODE_NAME_n` to be set if API token authentication is used and the token cannot automatically discover the node name.
172181
173182
<details>
174-
<summary><strong>Why <code>PBS_NODE_NAME</code> is Required (Click to Expand)</strong></summary>
183+
<summary><strong>Why <code>PBS_NODE_NAME</code> (or <code>PBS_NODE_NAME_n</code>) is Required (Click to Expand)</strong></summary>
175184
176185
Pulse needs to query task lists specific to the PBS node (e.g., `/api2/json/nodes/{nodeName}/tasks`). It attempts to discover this node name automatically by querying `/api2/json/nodes`. However, this endpoint is often restricted for API tokens (returning a 403 Forbidden error), even for tokens with high privileges, unless the `Sys.Audit` permission is granted on the root path (`/`).
177186
@@ -473,7 +482,7 @@ For development purposes or running directly from source, see the **[DEVELOPMENT
473482
- **Proxmox Backup Server:** Version 2.x or 3.x recommended (if monitored).
474483
- **Web Browser:** Modern evergreen browser.
475484
476-
## Contributing
485+
## 📝 Contributing
477486
478487
Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md).
479488
@@ -483,7 +492,7 @@ Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTIN
483492
* **Local Communication:** Operates entirely between your environment and your Proxmox/PBS APIs.
484493
* **Credential Handling:** Credentials are used only for API authentication and are not logged or sent elsewhere.
485494
486-
## 📜 License
495+
## 📜 License
487496
488497
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file.
489498

0 commit comments

Comments
 (0)