docs: add Docker Hub description with migration warnings

2026-09-22 19:23:31 +00:00 · 2025-08-05 15:13:46 +00:00
parent dfb224337f
commit 9e720eafd1
2 changed files with 84 additions and 0 deletions
@@ -0,0 +1,40 @@
+# Remaining Action Items for Pulse
+
+## Immediate Actions Needed
+
+### 1. Respond to GitHub Issues
+- [ ] Post migration guide link to issue #248
+- [ ] Post installation workarounds to issues #251 and #252
+- [ ] Close issues #249 and #250 as fixed in v4.0.1
+
+### 2. Monitor PR Status
+- [ ] Check status of Proxmox VE helper script PR
+- [ ] Once merged, update README to remove warning
+
+### 3. Consider v4.0.2 Release
+Given the documentation improvements and user confusion, consider releasing v4.0.2 with:
+- Migration guide included
+- Updated README with clear warnings
+- Helper script status documented
+
+## Known Issues to Track
+
+### v4 Issues
+- Fresh installs failing due to helper script (PR submitted)
+- Migration documentation was missing (now added)
+
+### v3 Issues (Not our focus)
+- #243: Security mode password issues
+- #245: Can't add 3rd node (limited to 2 nodes)
+- #246: v3.42.0 build broken
+
+## Future Improvements
+1. **Update install.sh** to better detect and handle v3 installations
+2. **Add authentication** to v4 (currently no login system)
+3. **Create automated tests** to prevent installation issues
+4. **Update Docker Hub** description with migration warnings
+
+## Communication Plan
+1. Update release notes for v4.0.0 and v4.0.1 to link to migration guide
+2. Consider pinning an issue about v3→v4 migration
+3. Add migration warning to Docker Hub description
@@ -0,0 +1,44 @@
+# Pulse for Proxmox
+
+Real-time monitoring for Proxmox VE and PBS with alerts, webhooks, and a clean web interface.
+
+## ⚠️ IMPORTANT: Upgrading from v3?
+
+**DO NOT pull latest if running v3!** Pulse v4 is a complete rewrite from Node.js to Go. Automatic upgrades will break your installation.
+
+See the [Migration Guide](https://github.com/rcourtman/Pulse/blob/main/docs/MIGRATION_V3_TO_V4.md) for upgrade instructions.
+
+## Quick Start
+
+```bash
+docker run -d \
+  --name pulse \
+  -p 7655:7655 \
+  -v pulse-data:/data \
+  --restart unless-stopped \
+  rcourtman/pulse:latest
+```
+
+Access at: `http://localhost:7655`
+
+## Key Changes in v4
+- Port changed: 3000 → **7655**
+- Complete rewrite in Go (no Node.js)
+- Configuration via web UI (no .env files)
+- Improved performance and lower resource usage
+
+## Environment Variables (Optional)
+
+Configure initial node via environment variables:
+- `PROXMOX_HOST` - PVE host (e.g., https://192.168.1.100:8006)
+- `PROXMOX_USER` - API user (e.g., monitor@pve)
+- `PROXMOX_TOKEN_NAME` - API token name
+- `PROXMOX_TOKEN_VALUE` - API token secret
+
+Or configure everything through the web UI after starting.
+
+## Documentation
+
+- [GitHub Repository](https://github.com/rcourtman/Pulse)
+- [Migration Guide (v3→v4)](https://github.com/rcourtman/Pulse/blob/main/docs/MIGRATION_V3_TO_V4.md)
+- [Latest Release](https://github.com/rcourtman/Pulse/releases/latest)