mirror of https://github.com/rcourtman/Pulse.git synced 2026-09-10 02:25:56 +00:00

Files

T

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

2.8 KiB

Raw Blame History

🚚 Migrating Pulse

This guide covers migrating Pulse to a new host using the built-in encrypted export/import workflow.

🚀 Quick Migration Guide

❌ DON'T: Copy Files

Never copy /etc/pulse (or /data in Docker/Kubernetes) manually. Encryption keys and credentials can break.

✅ DO: Use Export/Import

1. Export (Old Server)

Go to Settings → System → Backups.
Click Create Backup.
Enter a strong passphrase and download the encrypted backup.

2. Import (New Server)

Install a fresh Pulse instance.
Go to Settings → System → Backups.
Click Restore Configuration and upload your file.
Enter the passphrase.

📦 What Gets Migrated

Included ✅	Not Included ❌
Nodes & credentials	Historical metrics history (`metrics.db`)
Alerts & overrides	Browser sessions and local cookies
Notifications (email, webhooks, Apprise)	Local login username/password (`.env`)
System settings (`system.json`)	Update history/backup folders
API token records
OIDC config
Guest metadata/notes

🔄 Common Scenarios

Moving to New Hardware

Export from old → Install new → Import.

Docker ↔ Systemd ↔ Kubernetes

The export file works across all installation methods. You can migrate from Docker to Kubernetes or vice versa seamlessly.

Disaster Recovery

Install Pulse using Docker or your preferred method (see INSTALL.md).
Import your latest backup.
Restored in < 5 minutes.

📋 Post-Migration Checklist

Because local login credentials are stored in .env (not part of exports), you must:

Re-create Admin User: If not using .env overrides, create your admin account on the new instance.
Confirm API access:
- If you created API tokens in the UI, those token records are included in the export and should continue working.
- If you used .env-based API_TOKENS/API_TOKEN (legacy), reconfigure them on the new host or re-create tokens in the UI.
Update Agents:
- Unified Agent: Update the --token flag in your service definition.
- Docker: Update PULSE_TOKEN in your container config.
- Tip: You can use the "Install New Agent" wizard to generate updated install commands.

🔒 Security

Encryption: Exports are encrypted with passphrase-based encryption (PBKDF2 + AES-GCM).
Storage: Safe to store in cloud backups or password managers.
Passphrase: Use a strong, unique passphrase (min 12 chars).

🔧 Troubleshooting

"Invalid passphrase": Ensure exact match (case-sensitive).
Missing Nodes: Verify export date.
Connection Errors: Update node IPs in Settings if they changed.
Logging: Adjust LOG_LEVEL/LOG_FORMAT via environment variables if needed.

2.8 KiB Raw Blame History