danvics/Pulse
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: clarify auto-update flow and surface proxy guide

Browse source
This commit is contained in:
rcourtman 2025-11-14 01:06:11 +00:00
parent a163988bf5
commit 7a9c420912
2 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/INSTALL.md
View file

@ -130,15 +130,18 @@ systemctl status pulse-update.timer # Check status
# Via Settings UI # Via Settings UI
# Navigate to Settings → System → Enable "Automatic Updates" # Navigate to Settings → System → Enable "Automatic Updates"
``` ```
> The timer only runs when `autoUpdateEnabled` is `true` in `/var/lib/pulse/system.json`. Toggling the UI switch updates that flag automatically.
#### How It Works #### How It Works
- Checks daily between 2-6 AM (randomized to avoid server load) - Runs daily between 02:00–06:00 local time with a random jitter (systemd timer)
- Only installs stable releases (never release candidates) - Installs **stable tags only** (release candidates are skipped)
- Creates backup before updating - Creates a configuration backup and records `backup_path` inside update history
- Automatically rolls back if update fails - Automatically rolls back and restores the backup if the upgrade fails
- Logs all activity to systemd journal - Logs to `journalctl -u pulse-update` **and** `/var/log/pulse/update-*.log`
- Adaptive monitoring ships with circuit breakers, staleness tracking, and richer poll metrics, and the bundled Helm chart mirrors these defaults for Kubernetes clusters. - Records every attempt in **Settings → System → Updates** and `/api/updates/history`
- Rollback history is retained in Settings → System → Updates; use the **Restore previous version** button if the latest build regresses. - Requires `autoUpdateEnabled: true`; otherwise the service exits immediately
Need deeper operational guidance? See [operations/auto-update.md](operations/auto-update.md) for the full runbook (manual triggers, rollback steps, troubleshooting).
#### View Update Logs #### View Update Logs
```bash ```bash

1
docs/README.md
View file

@ -29,6 +29,7 @@ section groups related guides so you can jump straight to the material you need.
- [monitoring/](monitoring/) – Adaptive polling and Prometheus metric references. - [monitoring/](monitoring/) – Adaptive polling and Prometheus metric references.
- [WEBHOOKS.md](WEBHOOKS.md) – Notification providers and payload templates. - [WEBHOOKS.md](WEBHOOKS.md) – Notification providers and payload templates.
- [TROUBLESHOOTING.md](TROUBLESHOOTING.md) – Deep dive into common operational issues. - [TROUBLESHOOTING.md](TROUBLESHOOTING.md) – Deep dive into common operational issues.
- [../cmd/pulse-sensor-proxy/README.md](../cmd/pulse-sensor-proxy/README.md) – Host-side sensor proxy installation and operations guide.
## Security ## Security