gsadmin/pulse
1
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-09-22 11:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: remove non-existent PBS Agent references and correct DISCOVERY_SUBNET docs

Browse Source 
- Remove all PBS-AGENT.md references (hallucinated feature)
- Fix DISCOVERY_SUBNET env var name in Docker docs (was incorrectly PULSE_DISCOVERY_SUBNET)
- Add DISCOVERY_SUBNET examples to README for Docker users
- Update FAQ to clarify PBS push mode is not supported

Addresses #214 - user reported 404 on PBS-AGENT.md link
This commit is contained in:
Pulse Monitor
2025-08-19 08:30:27 +00:00
parent ce208f59a4
commit d16f2deeb2
3 changed files with 8 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -11
View File
@@ -87,16 +87,15 @@ docker run -d \
### With Network Discovery
```bash
# Discovery runs automatically but may detect Docker's internal network
# For proper discovery, configure subnet after first start:
# 1. Access Pulse UI
# 2. Edit /data/system.json and add: "discoverySubnet": "192.168.1.0/24"
# 3. Restart container
# Set your local subnet via environment variable:
docker run -d \
--name pulse \
-p 7655:7655 \
-v pulse_data:/data \
-e DISCOVERY_SUBNET="192.168.1.0/24" \
--restart unless-stopped \
rcourtman/pulse:latest
# Or configure later via UI Settings or /data/system.json
```
### Docker Compose
@@ -110,8 +109,8 @@ services:
volumes:
- pulse_data:/data
environment:
# Network discovery (configured via system.json after first start)
# Add to /data/system.json: "discoverySubnet": "192.168.1.0/24"
# Network discovery
# - DISCOVERY_SUBNET=192.168.1.0/24 # Your local subnet (default: auto-detect)
# Ports
# - PORT=7655 # Backend port (default: 7655)
@@ -149,10 +148,6 @@ volumes:
```
## PBS Agent (Push Mode)
For isolated PBS servers, see [PBS Agent documentation](docs/PBS-AGENT.md)
## Security
- **Authentication required** - Protects your Proxmox infrastructure credentials
@@ -385,7 +380,6 @@ journalctl -u pulse -f
- [API Reference](docs/API.md) - REST API endpoints and examples
- [Webhook Guide](docs/WEBHOOKS.md) - Setting up webhooks and custom payloads
- [Reverse Proxy Setup](docs/REVERSE_PROXY.md) - nginx, Caddy, Apache, Traefik configs
- [PBS Agent](docs/PBS-AGENT.md) - Monitoring isolated PBS servers
- [Security](docs/SECURITY.md) - Security features and best practices
- [FAQ](docs/FAQ.md) - Common questions and troubleshooting
- [Migration Guide](docs/MIGRATION.md) - Backup and migration procedures
docs/DOCKER.md
+2 -2
View File
@@ -160,7 +160,7 @@ To configure the correct subnet:
Or set via environment:
```yaml
environment:
PULSE_DISCOVERY_SUBNET: "192.168.1.0/24"
DISCOVERY_SUBNET: "192.168.1.0/24"
```
## Common Issues
@@ -218,7 +218,7 @@ Common problems:
|----------|-------------|---------|
| `PORT` | Web UI port | `7655` |
| `ALLOWED_ORIGINS` | CORS origins | Same-origin only |
| `PULSE_DISCOVERY_SUBNET` | Network to scan | Auto-detect |
| `DISCOVERY_SUBNET` | Network to scan | Auto-detect |
### System
| Variable | Description | Default |
docs/FAQ.md
+1 -1
View File
@@ -82,7 +82,7 @@ Reduce `metricsRetentionDays` in settings and restart
Yes, add multiple nodes in Settings
### PBS push mode?
Yes, use PBS agent for isolated servers. See [PBS Agent docs](PBS-AGENT.md)
No, PBS push mode is not currently supported. PBS monitoring requires network connectivity from Pulse to the PBS server.
### Webhook providers?
Discord, Slack, Gotify, Telegram, ntfy.sh, Teams, generic JSON