Skip to content

Commit c5ca5f4

Browse files
rcourtmanclaude
andcommitted
docs: improve and consolidate update instructions in README
- Add dedicated "Updating Pulse" section with clear table of contents entry - Consolidate scattered update information into one comprehensive section - Provide specific instructions for each installation method: * Community Scripts: simple re-run command * Docker Compose: pull and restart workflow * Manual LXC: script re-run with service management * Release Tarball: step-by-step update process * Development/Source: corrected npm workflow - Remove duplicate update instructions from Manual LXC section - Fix development workflow to reflect actual package.json scripts - Verify all instructions against source code for accuracy 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 328e67b commit c5ca5f4

File tree

1 file changed

+74
-27
lines changed

1 file changed

+74
-27
lines changed

README.md

Lines changed: 74 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ sudo ./install-pulse.sh
101101
- [Node.js (Development)](#️-running-the-application-nodejs-development)
102102
- [Features](#-features)
103103
- [System Requirements](#-system-requirements)
104+
- [Updating Pulse](#-updating-pulse)
104105
- [Contributing](#-contributing)
105106
- [Privacy](#-privacy)
106107
- [License](#-license)
@@ -230,33 +231,7 @@ Visit the [Community Scripts page](https://community-scripts.github.io/ProxmoxVE
230231
* Optionally enabling automatic updates via cron.
231232
4. **Access Pulse:** The script will display the URL (e.g., `http://<LXC-IP-ADDRESS>:7655`).
232233

233-
<details>
234-
<summary><strong>Updating and Managing the LXC Installation (Click to Expand)</strong></summary>
235-
236-
**Updating Pulse:**
237-
238-
Re-run the script from the directory where you downloaded it:
239-
```bash
240-
./install-pulse.sh
241-
```
242-
Or run non-interactively (e.g., for cron):
243-
```bash
244-
./install-pulse.sh --update
245-
```
246-
247-
**Managing the Pulse Service:**
248-
249-
Use standard `systemctl` commands:
250-
* Check Status: `sudo systemctl status pulse-monitor.service`
251-
* Stop Service: `sudo systemctl stop pulse-monitor.service`
252-
* Start Service: `sudo systemctl start pulse-monitor.service`
253-
* View Logs: `sudo journalctl -u pulse-monitor.service -f`
254-
* Enable/Disable on Boot: `sudo systemctl enable/disable pulse-monitor.service`
255-
256-
**Automatic Updates:**
257-
If enabled via the script, a cron job runs `./install-pulse.sh --update` Daily/Weekly/Monthly. Logs are in `/var/log/pulse_update.log`. Manage with `sudo crontab -l -u root` or `sudo crontab -e -u root`.
258-
259-
</details>
234+
For update instructions, see the [Updating Pulse](#-updating-pulse) section.
260235

261236
---
262237

@@ -504,6 +479,78 @@ For development purposes or running directly from source, see the **[DEVELOPMENT
504479
- **Proxmox Backup Server:** Version 2.x or 3.x recommended (if monitored).
505480
- **Web Browser:** Modern evergreen browser.
506481
482+
## 🔄 Updating Pulse
483+
484+
### Community Scripts LXC Installation
485+
486+
If you installed using the Community Scripts method, simply re-run the original installation command:
487+
488+
```bash
489+
bash -c "$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/pulse.sh)"
490+
```
491+
492+
The script will detect the existing installation and update it automatically.
493+
494+
### Docker Compose Installation
495+
496+
To update a Docker Compose installation:
497+
498+
```bash
499+
cd /path/to/your/pulse-config
500+
docker compose pull
501+
docker compose up -d
502+
```
503+
504+
This pulls the latest image and recreates the container with the new version.
505+
506+
### Manual LXC Installation
507+
508+
If you used the manual installation script, update by re-running it:
509+
510+
```bash
511+
# Navigate to where you downloaded the script
512+
cd /path/to/script/directory
513+
./install-pulse.sh
514+
```
515+
516+
Or run non-interactively (useful for automated updates):
517+
518+
```bash
519+
./install-pulse.sh --update
520+
```
521+
522+
**Managing the Service:**
523+
- Check status: `sudo systemctl status pulse-monitor.service`
524+
- View logs: `sudo journalctl -u pulse-monitor.service -f`
525+
- Restart: `sudo systemctl restart pulse-monitor.service`
526+
527+
**Automatic Updates:**
528+
If you enabled automatic updates during installation, they run via cron. Check logs in `/var/log/pulse_update.log`.
529+
530+
### Release Tarball Installation
531+
532+
To update a tarball installation:
533+
534+
1. Download the latest release from [GitHub Releases](https://github.com/rcourtman/Pulse/releases/latest)
535+
2. Stop the current application
536+
3. Extract the new tarball to a new directory
537+
4. Copy your existing `.env` file to the new directory
538+
5. Start the application: `npm start`
539+
540+
### Development/Source Installation
541+
542+
If running from source code:
543+
544+
```bash
545+
cd /path/to/pulse
546+
git pull origin main
547+
npm install
548+
npm run build:css
549+
npm run start # or your preferred restart method
550+
```
551+
552+
**Note:** The development setup only requires npm install in the root directory, not in a separate server directory.
553+
507554
## 📝 Contributing
508555
509556
Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md).

0 commit comments

Comments
 (0)