Update docs with missing config, API endpoints, and Docker Compose

This commit is contained in:
courtmanr@gmail.com 2025-12-02 20:46:21 +00:00
parent b3fd15d522
commit edcf62f193
3 changed files with 86 additions and 3 deletions

View file

@ -112,6 +112,51 @@ Triggers a test alert to all configured channels.
---
---
## 🖥️ Host Agent
### Submit Report
`POST /api/agents/host/report`
Used by the Pulse Host Agent to push system metrics.
### Lookup Agent
`POST /api/agents/host/lookup`
Check if a host agent is already registered.
### Delete Host
`DELETE /api/agents/host/<id>`
Remove a host agent from monitoring.
---
## ⚙️ System Settings
### Get Settings
`GET /api/config/system`
Retrieve current system configuration.
### Toggle Mock Mode
`POST /api/system/mock-mode`
Enable or disable mock data generation (dev/demo only).
---
## 🔑 OIDC / SSO
### Get OIDC Config
`GET /api/security/oidc`
Retrieve current OIDC provider settings.
### Update OIDC Config
`POST /api/security/oidc`
Configure OIDC provider details (Issuer, Client ID, etc).
### Login
`GET /api/oidc/login`
Initiate OIDC login flow.
---
## 🐳 Docker Agent
### Submit Report

View file

@ -79,10 +79,26 @@ Environment variables take precedence over `system.json`.
| Variable | Description | Default |
|----------|-------------|---------|
| `FRONTEND_PORT` | Public listening port | `7655` |
| `LOG_LEVEL` | Log verbosity | `info` |
| `DISCOVERY_ENABLED` | Auto-discover nodes | `false` |
| `LOG_LEVEL` | Log verbosity (`debug`, `info`, `warn`, `error`) | `info` |
| `PULSE_PUBLIC_URL` | Public URL for notifications/OIDC | `""` |
| `ALLOWED_ORIGINS` | CORS allowed domains | `""` (Same origin) |
| `PULSE_AUTH_HIDE_LOCAL_LOGIN` | Hide username/password form (useful for SSO) | `false` |
| `DISCOVERY_ENABLED` | Auto-discover nodes | `false` |
| `PULSE_AUTH_HIDE_LOCAL_LOGIN` | Hide username/password form | `false` |
| `DEMO_MODE` | Enable read-only demo mode | `false` |
### Monitoring Overrides
| Variable | Description | Default |
|----------|-------------|---------|
| `PVE_POLLING_INTERVAL` | PVE metrics polling frequency | `10s` |
| `PBS_POLLING_INTERVAL` | PBS metrics polling frequency | `60s` |
| `PMG_POLLING_INTERVAL` | PMG metrics polling frequency | `60s` |
| `ENABLE_BACKUP_POLLING` | Enable backup job monitoring | `true` |
| `BACKUP_POLLING_INTERVAL` | Backup polling frequency | `0` (Auto) |
| `ENABLE_TEMPERATURE_MONITORING` | Enable SSH temperature checks | `true` |
| `SSH_PORT` | SSH port for temperature checks | `22` |
| `ADAPTIVE_POLLING_ENABLED` | Enable smart polling for large clusters | `false` |
| `WEBHOOK_BATCH_DELAY` | Delay before sending batched webhooks | `10s` |
---

View file

@ -23,6 +23,28 @@ docker run -d \
rcourtman/pulse:latest
```
### Docker Compose
Create a `docker-compose.yml` file:
```yaml
services:
pulse:
image: rcourtman/pulse:latest
container_name: pulse
restart: unless-stopped
ports:
- "7655:7655"
volumes:
- pulse_data:/data
- /var/run/docker.sock:/var/run/docker.sock # Optional: Monitor local Docker
environment:
- PULSE_AUTH_USER=admin
- PULSE_AUTH_PASS=secret123
volumes:
pulse_data:
```
---
## 🛠️ Installation Methods