Pulse for Proxmox VE

A lightweight monitoring application for Proxmox VE that displays real-time status for VMs and containers via a simple web interface.

📸 Screenshots

Click to view other UI tabs

PBS Tab:

Backups Tab:

Line Graph Toggle:

🚀 Quick Start

Choose your preferred installation method:

📦 Easiest: Proxmox Community Scripts (Recommended)

One-command installation in a new LXC container:

bash -c "$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/pulse.sh)"

This will create a new LXC container and install Pulse automatically. Visit the Community Scripts page for details.

🐳 Docker Compose (Pre-built Image)

For existing Docker hosts:

mkdir pulse-config && cd pulse-config
# Create .env file with your Proxmox details (see Configuration section)
# Create docker-compose.yml (see Docker section)
docker compose up -d

🛠️ Manual LXC Installation

For existing LXC containers:

curl -sLO https://raw.githubusercontent.com/rcourtman/Pulse/main/scripts/install-pulse.sh
chmod +x install-pulse.sh
sudo ./install-pulse.sh

✅ Prerequisites

Before installing Pulse, ensure you have:

For Proxmox VE:

Proxmox VE 7.x or 8.x running
Admin access to create API tokens
Network connectivity between Pulse and Proxmox (ports 8006/8007)

For Pulse Installation:

Community Scripts: Just a Proxmox host (handles everything automatically)
Docker: Docker & Docker Compose installed
Manual LXC: Existing Debian/Ubuntu LXC with internet access

🚀 Deployment Options

Proxmox Community Scripts (Automated LXC)

✨ Easiest method - fully automated LXC creation and setup:

bash -c "$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/pulse.sh)"

This script will:

Create a new LXC container automatically
Install all dependencies (Node.js, npm, etc.)
Download and configure Pulse
Set up systemd service
Guide you through Proxmox API token setup

After installation: Access Pulse at http://<lxc-ip>:7655

Visit the Community Scripts page for more details.

Docker Compose (Recommended for Existing Hosts)

For existing Docker hosts - uses pre-built image:

Prerequisites:

Docker (Install Docker)
Docker Compose (Install Docker Compose)

Steps:

Create a Directory: Make a directory on your Docker host where Pulse configuration will live:
```
mkdir pulse-config
cd pulse-config
```

Create .env file: Create a file named .env in this directory and add your Proxmox connection details. See Configuration for details and required permissions. Minimally, you need:

# .env file
PROXMOX_HOST=https://your-proxmox-ip:8006
PROXMOX_TOKEN_ID=your_user@pam!your_token_id
PROXMOX_TOKEN_SECRET=your_secret_uuid_here
# Optional: Set to true if using self-signed certs
# PROXMOX_ALLOW_SELF_SIGNED_CERTS=true
# Optional: Add PBS details if desired
# PBS_HOST=https://your-pbs-ip:8007
# PBS_NODE_NAME=your-pbs-node-hostname # Important! See config docs.
# PBS_TOKEN_ID=pbs_user@pbs!token_id
# PBS_TOKEN_SECRET=pbs_secret_uuid_here
# PBS_ALLOW_SELF_SIGNED_CERTS=true

Create docker-compose.yml file: Create a file named docker-compose.yml in the same directory with the following content:

# docker-compose.yml
services:
  pulse-server:
    image: rcourtman/pulse:latest # Pulls the latest pre-built image
    container_name: pulse
    restart: unless-stopped
    ports:
      # Map host port 7655 to container port 7655
      # Change the left side (e.g., "8081:7655") if 7655 is busy on your host
      - "7655:7655"
    env_file:
      - .env # Load environment variables from .env file
    # Optional: Uncomment to map a volume for potential future config/log persistence
    # volumes:
    #   - ./data:/data

Run: Start the container:
```
docker compose up -d
```
Access: Open your browser to http://<your-docker-host-ip>:7655.

Manual LXC Installation

For existing Debian/Ubuntu LXC containers:

Prerequisites:

A running Proxmox VE host
An existing Debian or Ubuntu LXC container with network access to Proxmox
- Tip: Use Community Scripts to easily create one: bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/debian.sh)"

Steps:

Access LXC Console: Log in to your LXC container (usually as root).

Download and Run Script:

# Ensure you are in a suitable directory, like /root or /tmp
curl -sLO https://raw.githubusercontent.com/rcourtman/Pulse/main/scripts/install-pulse.sh
chmod +x install-pulse.sh
./install-pulse.sh

Follow Prompts: The script guides you through:
- Installing dependencies (git, curl, nodejs, npm, sudo).
- Entering your Proxmox Host URL, API Token ID, Secret, and self-signed cert preference.
- (Optional) Entering PBS connection details if desired.
- Setting up Pulse as a systemd service (pulse-monitor.service).
- Optionally enabling automatic updates via cron.
Access Pulse: The script will display the URL (e.g., http://<LXC-IP-ADDRESS>:7655).

Updating and Managing the LXC Installation (Click to Expand)

Updating Pulse:

Re-run the script from the directory where you downloaded it:

./install-pulse.sh

Or run non-interactively (e.g., for cron):

./install-pulse.sh --update

Managing the Pulse Service:

Use standard systemctl commands:

Check Status: sudo systemctl status pulse-monitor.service
Stop Service: sudo systemctl stop pulse-monitor.service
Start Service: sudo systemctl start pulse-monitor.service
View Logs: sudo journalctl -u pulse-monitor.service -f
Enable/Disable on Boot: sudo systemctl enable/disable pulse-monitor.service

Automatic Updates: 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.

Development Setup (Docker Compose)

Use this method if you have cloned the repository and want to build and run the application from the local source code.

Get Files: Clone the repository (git clone https://github.com/rcourtman/Pulse.git && cd Pulse)
Copy .env: cp .env.example .env
Edit .env: Fill in your primary Proxmox API details (PROXMOX_HOST, PROXMOX_TOKEN_ID, PROXMOX_TOKEN_SECRET). See Configuration for details.
Run: docker compose up --build -d (The included docker-compose.yml uses the build: context by default).
Access: Open your browser to http://localhost:7655 (or your host IP if Docker runs remotely).

🛠️ Configuration

Environment Variables

Pulse is configured using environment variables, typically set in a .env file in the project root.

Copy Example File: If you haven't already, copy the example file:
```
cp .env.example .env
```
Edit .env: Open .env in a text editor and update the values for your environment(s).

Proxmox VE (Primary Environment)

These are the minimum required variables:

PROXMOX_HOST: URL of your Proxmox server (e.g., https://192.168.1.10:8006).
PROXMOX_TOKEN_ID: Your API Token ID (e.g., user@pam!tokenid).
PROXMOX_TOKEN_SECRET: Your API Token Secret.

Optional variables:

PROXMOX_NODE_NAME: A display name for this endpoint in the UI (defaults to PROXMOX_HOST).
PROXMOX_ALLOW_SELF_SIGNED_CERTS: Set to true if your Proxmox server uses self-signed SSL certificates. Defaults to false.
PORT: Port for the Pulse server to listen on. Defaults to 7655.
(Username/Password fallback exists but API Token is strongly recommended)

Alert System Configuration (Optional)

Pulse includes a comprehensive alert system that monitors resource usage and system status:

# Alert System Configuration
ALERT_CPU_ENABLED=true
ALERT_MEMORY_ENABLED=true
ALERT_DISK_ENABLED=true
ALERT_DOWN_ENABLED=true

# Alert thresholds (percentages)
ALERT_CPU_THRESHOLD=85
ALERT_MEMORY_THRESHOLD=90
ALERT_DISK_THRESHOLD=95

# Alert durations (milliseconds - how long condition must persist)
ALERT_CPU_DURATION=300000       # 5 minutes
ALERT_MEMORY_DURATION=300000    # 5 minutes  
ALERT_DISK_DURATION=600000      # 10 minutes
ALERT_DOWN_DURATION=60000       # 1 minute

Alert features include:

Real-time notifications with toast messages
Multi-severity alerts (Critical, Warning, Resolved)
Duration-based triggering (alerts only fire after conditions persist)
Automatic resolution when conditions normalize
Alert history tracking

Note: For a Proxmox cluster, you only need to provide connection details for one node. Pulse automatically discovers other cluster members.

Multiple Proxmox Environments (Optional)

To monitor separate Proxmox environments (e.g., different clusters, sites) in one Pulse instance, add numbered variables:

PROXMOX_HOST_2, PROXMOX_TOKEN_ID_2, PROXMOX_TOKEN_SECRET_2
PROXMOX_HOST_3, PROXMOX_TOKEN_ID_3, PROXMOX_TOKEN_SECRET_3
...and so on.

Optional numbered variables also exist (e.g., PROXMOX_ALLOW_SELF_SIGNED_CERTS_2, PROXMOX_NODE_NAME_2).

Proxmox Backup Server (PBS) (Optional)

To monitor PBS instances:

Primary PBS Instance:

PBS_HOST: URL of your PBS server (e.g., https://192.168.1.11:8007).
PBS_TOKEN_ID: Your PBS API Token ID (e.g., user@pbs!tokenid). See Creating a Proxmox Backup Server API Token.
PBS_TOKEN_SECRET: Your PBS API Token Secret.
PBS_NODE_NAME: Important! The internal hostname of your PBS server (e.g., pbs-server-01). This is usually required for API token auth because the token might lack permission to auto-discover the node name. See details below.
PBS_ALLOW_SELF_SIGNED_CERTS: Set to true for self-signed certificates. Defaults to false.
PBS_PORT: PBS API port. Defaults to 8007.

Additional PBS Instances:

To monitor multiple PBS instances, add numbered variables, starting with _2:

PBS_HOST_2, PBS_TOKEN_ID_2, PBS_TOKEN_SECRET_2
PBS_HOST_3, PBS_TOKEN_ID_3, PBS_TOKEN_SECRET_3
...and so on.

Optional numbered variables also exist for additional PBS instances (e.g., PBS_NODE_NAME_2, PBS_ALLOW_SELF_SIGNED_CERTS_2, PBS_PORT_2). Each PBS instance, whether primary or additional, requires its respective PBS_NODE_NAME or PBS_NODE_NAME_n to be set if API token authentication is used and the token cannot automatically discover the node name.

Why PBS_NODE_NAME (or PBS_NODE_NAME_n) is Required (Click to Expand)

Pulse needs to query task lists specific to the PBS node (e.g., /api2/json/nodes/{nodeName}/tasks). It attempts to discover this node name automatically by querying /api2/json/nodes. However, this endpoint is often restricted for API tokens (returning a 403 Forbidden error), even for tokens with high privileges, unless the Sys.Audit permission is granted on the root path (/).

Therefore, setting PBS_NODE_NAME in your .env file is the standard and recommended way to ensure Pulse can correctly query task endpoints when using API token authentication. If it's not set and automatic discovery fails due to permissions, Pulse will be unable to fetch task data (backups, verifications, etc.).

How to find your PBS Node Name:

SSH: Log into your PBS server via SSH and run hostname.
UI: Log into the PBS web interface. The hostname is typically displayed on the Dashboard under Server Status.

Example: If your PBS connects via https://minipc-pbs.lan:8007 but its internal hostname is proxmox-backup-server, set:

PBS_HOST=https://minipc-pbs.lan:8007
PBS_NODE_NAME=proxmox-backup-server

Creating a Proxmox API Token

Using an API token is the recommended authentication method.

Steps to Create a PVE API Token (Click to Expand)

Log in to the Proxmox VE web interface.
Create a dedicated user (optional but recommended):
- Go to Datacenter → Permissions → Users.
- Click Add. Enter a User name (e.g., "pulse-monitor"), set Realm to Proxmox VE authentication server (pam), set a password, ensure Enabled. Click Add.
Create an API token:
- Go to Datacenter → Permissions → API Tokens.
- Click Add.
- Select the User (e.g., "pulse-monitor@pam") or root@pam.
- Enter a Token ID (e.g., "pulse").
- Leave Privilege Separation checked. Click Add.
- Important: Copy the Secret value immediately. It's shown only once.
Assign permissions (to User and Token):
- Go to Datacenter → Permissions.
- Add User Permission: Click Add → User Permission. Path: /, User: pulse-monitor@pam, Role: PVEAuditor, check Propagate. Click Add.
- Add Token Permission: Click Add → API Token Permission. Path: /, API Token: pulse-monitor@pam!pulse, Role: PVEAuditor, check Propagate. Click Add.
- Note: The PVEAuditor role at the root path (/) with Propagate is crucial.
Update .env: Set PROXMOX_TOKEN_ID (e.g., pulse-monitor@pam!pulse) and PROXMOX_TOKEN_SECRET (the secret you copied).

Creating a Proxmox Backup Server API Token

If monitoring PBS, create a token within the PBS interface.

Steps to Create a PBS API Token (Click to Expand)

Log in to the Proxmox Backup Server web interface.
Create a dedicated user (optional but recommended):
- Go to Configuration → Access Control → User Management.
- Click Add. Enter User ID (e.g., "pulse-monitor@pbs"), set Realm (likely pbs), add password. Click Add.
Create an API token:
- Go to Configuration → Access Control → API Token.
- Click Add.
- Select User (e.g., "pulse-monitor@pbs") or root@pam.
- Enter Token Name (e.g., "pulse").
- Leave Privilege Separation checked. Click Add.
- Important: Copy the Secret value immediately.
Assign permissions:
- Go to Configuration → Access Control → Permissions.
- Click Add → API Token Permission.
- Path: / (root level).
- API Token: Select the token (e.g., "pulse-monitor@pbs!pulse").
- Role: Audit.
- Check Propagate. Click Add.
- Note: The Audit role at root path (/) is needed for read-only access.
Update .env: Set PBS_TOKEN_ID (e.g., pulse-monitor@pbs!pulse) and PBS_TOKEN_SECRET.

Required Permissions

Proxmox VE: The PVEAuditor role assigned at path / with Propagate enabled is recommended.

Permissions included in PVEAuditor (Click to Expand)
- `Datastore.Audit` - `Permissions.Read` (implicitly included) - `Pool.Audit` - `Sys.Audit` - `VM.Audit`
Proxmox Backup Server: The Audit role assigned at path / with Propagate enabled is recommended.

Running from Release Tarball

For users who prefer not to use Docker or the LXC script, pre-packaged release tarballs are available.

Prerequisites:

Node.js (Version 18.x or later recommended)
npm (comes with Node.js)
tar command (standard on Linux/macOS, available via tools like 7-Zip or WSL on Windows)

Steps:

Download: Go to the Pulse GitHub Releases page. Download the pulse-vX.Y.Z.tar.gz file for the desired release.

Extract: Create a directory and extract the tarball:

mkdir pulse-app
cd pulse-app
tar -xzf /path/to/downloaded/pulse-vX.Y.Z.tar.gz
# This creates a directory like pulse-vX.Y.Z/
cd pulse-vX.Y.Z

Configure: Copy the environment file template and edit it with your details (see Configuration):
```
cp .env.example .env
nano .env # Or your preferred editor
```
Run: Start the application using npm:
```
npm start
```
(Note: The tarball includes pre-installed production dependencies, so npm install is not typically required unless you encounter issues.)
Access: Open your browser to http://<your-server-ip>:7655 (or the port configured in .env).

️ Running the Application (Node.js - Development)

For development purposes or running directly from source, see the DEVELOPMENT.md guide. This involves cloning the repository, installing dependencies using npm install in both the root and server directories, and running npm run dev or npm run start.

✨ Features

Lightweight monitoring for Proxmox VE nodes, VMs, and Containers.
Real-time status updates via WebSockets.
Simple, responsive web interface.
Built-in diagnostic tool with API permission testing and troubleshooting guidance.
Advanced alert system with configurable thresholds and durations.
Efficient polling: Stops API polling when no clients are connected.
Docker support.
Multi-environment PVE monitoring support.
Proxmox Backup Server (PBS) monitoring support.
LXC installation script.

💻 System Requirements

Node.js: Version 18.x or later (if building/running from source).
NPM: Compatible version with Node.js.
Docker & Docker Compose: Latest stable versions (if using container deployment).
Proxmox VE: Version 7.x or 8.x recommended.
Proxmox Backup Server: Version 2.x or 3.x recommended (if monitored).
Web Browser: Modern evergreen browser.

📝 Contributing

Contributions are welcome! Please read our Contributing Guidelines.

🔒 Privacy

No Data Collection: Pulse does not collect or transmit any telemetry or user data externally.
Local Communication: Operates entirely between your environment and your Proxmox/PBS APIs.
Credential Handling: Credentials are used only for API authentication and are not logged or sent elsewhere.

📜 License

This project is licensed under the MIT License - see the LICENSE file.

™️ Trademark Notice

Proxmox® and Proxmox VE® are registered trademarks of Proxmox Server Solutions GmbH. This project is not affiliated with or endorsed by Proxmox Server Solutions GmbH.

❤️ Support

File issues on the GitHub repository.

If you find Pulse useful, consider supporting its development:

❓ Troubleshooting

🔧 Quick Fixes

Can't access Pulse after installation?

# Check if service is running
sudo systemctl status pulse-monitor.service

# Check what's listening on port 7655
sudo netstat -tlnp | grep 7655

# View recent logs
sudo journalctl -u pulse-monitor.service -f

Empty dashboard or "No data" errors?

Check API Token: Verify your PROXMOX_TOKEN_ID and PROXMOX_TOKEN_SECRET are correct
Test connectivity: Can you ping your Proxmox host from where Pulse is running?
Check permissions: Ensure token has PVEAuditor role on path / with Propagate enabled

"Empty Backups Tab" with PBS configured?

Add PBS_NODE_NAME=your-pbs-hostname to your .env file
Find hostname with: ssh root@your-pbs-ip hostname

Docker container won't start?

# Check container logs
docker logs pulse

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

Diagnostic Tool

Pulse includes a comprehensive built-in diagnostic tool to help troubleshoot configuration and connectivity issues:

Web Interface (Recommended):

The diagnostics icon appears automatically in the header when issues are detected
Click the icon or navigate to http://your-pulse-host:7655/diagnostics.html
The tool will automatically run diagnostics and provide:
- API Token Permission Testing - Tests actual API permissions for VMs, containers, nodes, and datastores
- Configuration Validation - Verifies all connection settings and required parameters
- Real-time Connectivity Tests - Tests live connections to Proxmox VE and PBS instances
- Data Flow Analysis - Shows discovered nodes, VMs, containers, and backup data
- Specific Actionable Recommendations - Detailed guidance for fixing any issues found

Key Features:

Tests use the same API endpoints as the main application for accuracy
Provides exact permission requirements (e.g., VM.Audit on / for Proxmox)
Shows counts of discovered resources (VMs, containers, nodes, backups)
Identifies common misconfigurations like missing PBS_NODE_NAME
Privacy Protected: Automatically sanitizes hostnames, IPs, and sensitive data before export
Export diagnostic reports safe for sharing in GitHub issues or support requests

Command Line:

# If using the source code:
./scripts/diagnostics.sh

# The script will generate a detailed report and save it to a timestamped file

Common Issues

Empty Backups Tab: Usually caused by missing PBS_NODE_NAME in your configuration. SSH to your PBS server and run hostname to find the correct value.
Pulse Application Logs: Check container logs (docker logs pulse_monitor) or service logs (sudo journalctl -u pulse-monitor.service -f) for errors (401 Unauthorized, 403 Forbidden, connection refused, timeout).
.env Configuration: Verify PROXMOX_HOST, PROXMOX_TOKEN_ID, PROXMOX_TOKEN_SECRET, and PROXMOX_ALLOW_SELF_SIGNED_CERTS. For PBS, also check PBS_HOST, PBS_TOKEN_ID, PBS_TOKEN_SECRET, PBS_ALLOW_SELF_SIGNED_CERTS, and especially PBS_NODE_NAME. Ensure no placeholder values remain.
Network Connectivity: Can the machine running Pulse reach the PVE/PBS hostnames/IPs and 5D32 ports (usually 8006 for PVE, 8007 for PBS)? Check firewalls.
API Token Permissions: Ensure the correct roles (PVEAuditor for PVE, Audit for PBS) are assigned at the root path (/) with Propagate enabled in the respective UIs.

Name		Name	Last commit message	Last commit date
Latest commit History 865 Commits
.github		.github
docs/images		docs/images
scripts		scripts
server		server
src		src
.env.example		.env.example
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
DEVELOPMENT.md		DEVELOPMENT.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
docker-compose.yml		docker-compose.yml
package-lock.json		package-lock.json
package.json		package.json

License

rcourtman/Pulse

Folders and files

Latest commit

History

Repository files navigation

Pulse for Proxmox VE

📸 Screenshots

🚀 Quick Start

📦 Easiest: Proxmox Community Scripts (Recommended)

🐳 Docker Compose (Pre-built Image)

🛠️ Manual LXC Installation

📋 Table of Contents

✅ Prerequisites

🚀 Deployment Options

Proxmox Community Scripts (Automated LXC)

Docker Compose (Recommended for Existing Hosts)

Manual LXC Installation

Development Setup (Docker Compose)

🛠️ Configuration

Environment Variables

Proxmox VE (Primary Environment)

Alert System Configuration (Optional)

Multiple Proxmox Environments (Optional)

Proxmox Backup Server (PBS) (Optional)

Creating a Proxmox API Token

Creating a Proxmox Backup Server API Token

Required Permissions

Running from Release Tarball

️ Running the Application (Node.js - Development)

✨ Features

💻 System Requirements

📝 Contributing

🔒 Privacy

📜 License

™️ Trademark Notice

❤️ Support

❓ Troubleshooting

🔧 Quick Fixes

Diagnostic Tool

Common Issues

About

Topics

Resources

License

Code of conduct

Uh oh!

Stars

Watchers

Forks

Releases 61

Packages 0

Uh oh!

Contributors 4

Uh oh!

Languages

Packages