Pulse/docs/AUTO_UPDATE.md
rcourtman dcdbee3c5c feat: Add in-app help system with HelpIcon component
Add contextual help icons throughout the UI to improve feature
discoverability. Users can click (?) icons to see explanations
with examples for settings they might not understand.

- HelpIcon component with click-to-open popover
- Centralized help content registry in /content/help/
- FeatureTip component for dismissible contextual tips
- Help added to: alert delay, AI endpoints, update channel
2026-01-07 09:22:23 +00:00

3.5 KiB

Automatic Updates

Pulse 5.0 introduces one-click updates for supported deployment types, making it easy to keep your monitoring system up to date.

Supported Deployment Types

Deployment Auto-Update Method
ProxmoxVE LXC Yes In-app update button
Systemd Service Yes In-app update button
Docker Manual Pull new image
Source Build Manual Git pull + rebuild

Using One-Click Updates

When an Update is Available

  1. Navigate to Settings → System → Updates
  2. If an update is available, you'll see an "Install Update" button
  3. Click the button to open the confirmation dialog
  4. Review the update details:
    • Current version → New version
    • Estimated time
    • Changelog highlights
  5. Click "Install Update" to begin

Update Process

  1. Download: New version is downloaded
  2. Backup: Current installation is backed up
  3. Apply: Files are updated
  4. Restart: Service restarts automatically
  5. Verify: Health check confirms success

Progress Tracking

A real-time progress modal shows:

  • Current step
  • Download progress
  • Any warnings or errors
  • Automatic page reload on success

Configuration

Update Preferences

In Settings → System → Updates:

Setting Description
Update Channel Stable (recommended) or Release Candidate
Auto-Check Automatically check for updates daily

Environment Variables

# Enable one-click updates
AUTO_UPDATE_ENABLED=true

# Use release candidate channel
UPDATE_CHANNEL=rc

# Adjust automatic check cadence (duration string)
AUTO_UPDATE_CHECK_INTERVAL=24h

# Schedule daily checks (HH:MM, 24h)
AUTO_UPDATE_TIME=03:00

Manual Update Methods

Docker

# Pull latest image
docker pull rcourtman/pulse:latest

# Restart container
docker-compose down && docker-compose up -d

ProxmoxVE LXC (Manual)

curl -fsSL https://github.com/rcourtman/Pulse/releases/latest/download/install.sh | bash

Systemd Service (Manual)

curl -fsSL https://github.com/rcourtman/Pulse/releases/latest/download/install.sh | bash

Source Build

cd /path/to/pulse
git pull
make build
sudo systemctl restart pulse

Rollback

If an update causes issues:

Automatic Rollback

Pulse creates a backup before updating. If the update fails:

  1. The previous version is automatically restored
  2. Service restarts with the old version
  3. Error details are logged

Manual Rollback

If rollback is supported for your deployment, use the Rollback action from the update history in Settings → System → Updates.

Backups are stored as backup-<timestamp>/ folders inside the Pulse data directory (/etc/pulse or /data).

Update History

View past updates in Settings → System → Updates → Update History:

  • Previous versions installed
  • Update timestamps
  • Success/failure status

Troubleshooting

Update button not showing

  1. Check if your deployment supports auto-update
  2. Verify an update is actually available
  3. Ensure you have the latest frontend loaded (hard refresh)

Update failed

  1. Check the error message in the progress modal
  2. Review logs: journalctl -u pulse -n 100
  3. Verify disk space is available
  4. Check network connectivity to GitHub

Service won't restart after update

  1. Check systemd status: systemctl status pulse
  2. View recent logs: journalctl -u pulse -f
  3. Manually restore from backup if needed