20 KiB
ProxMenux Monitor
A modern, responsive dashboard for monitoring Proxmox VE systems built with Next.js and React.
Table of Contents
- Overview
- Features
- Technology Stack
- Installation
- Authentication & Security
- API Documentation
- Integration Examples
- Onboarding Experience
- Contributing
Overview
ProxMenux Monitor is a comprehensive, real-time monitoring dashboard for Proxmox VE environments. Built with modern web technologies, it provides an intuitive interface to monitor system resources, virtual machines, containers, storage, network traffic, and system logs.
The application runs as a standalone AppImage on your Proxmox server and serves a web interface accessible from any device on your network.
Features
- System Overview: Real-time monitoring of CPU, memory, temperature, and system uptime
- Storage Management: Visual representation of storage distribution, disk health, and SMART data
- Network Monitoring: Network interface statistics, real-time traffic graphs, and bandwidth usage
- Virtual Machines & LXC: Comprehensive view of all VMs and containers with resource usage and controls
- Hardware Information: Detailed hardware specifications including CPU, GPU, PCIe devices, and disks
- System Logs: Real-time system log monitoring with filtering and search capabilities
- Health Monitoring: Proactive system health checks with persistent error tracking
- Authentication & 2FA: Optional password protection with TOTP-based two-factor authentication
- RESTful API: Complete API access for integrations with Homepage, Home Assistant, and custom dashboards
- Dark/Light Theme: Toggle between themes with Proxmox-inspired design
- Responsive Design: Works seamlessly on desktop, tablet, and mobile devices
- Release Notes: Automatic notifications of new features and improvements
Technology Stack
- Frontend: Next.js 15, React 19, TypeScript
- Styling: Tailwind CSS v4 with custom Proxmox-inspired theme
- Charts: Recharts for data visualization
- UI Components: Radix UI primitives with shadcn/ui
- Backend: Flask (Python) server for system data collection
- Packaging: AppImage for easy distribution and deployment
Installation
- Download the latest
ProxMenux-Monitor.AppImagefrom the releases page - Make it executable: ```bash chmod +x ProxMenux-Monitor.AppImage ```
- Run the AppImage: ```bash ./ProxMenux-Monitor.AppImage ```
- Access the dashboard at
http://your-proxmox-ip:8008
The application will start automatically and create a systemd service for persistence.
Authentication & Security
ProxMenux Monitor includes an optional authentication system to protect your dashboard with a password and two-factor authentication.
Setup Authentication
On first launch, you'll be presented with three options:
- Set up authentication - Create a username and password to protect your dashboard
- Enable 2FA - Add TOTP-based two-factor authentication for enhanced security
- Skip - Continue without authentication (not recommended for production environments)
Two-Factor Authentication (2FA)
After setting up your password, you can enable 2FA using any TOTP authenticator app (Google Authenticator, Authy, 1Password, etc.):
- Navigate to Settings > Authentication
- Click Enable 2FA
- Scan the QR code with your authenticator app
- Enter the 6-digit code to verify
- Save your backup codes in a secure location
API Documentation
ProxMenux Monitor provides a comprehensive RESTful API for integrating with external services like Homepage, Home Assistant, or custom dashboards.
API Authentication
When authentication is enabled on ProxMenux Monitor, all API endpoints (except /api/health and /api/auth/*) require a valid JWT token in the Authorization header.
API Endpoint Base URL
``` http://your-proxmox-ip:8008/api/ ```
Generating API Tokens
To use the API with authentication enabled, you need to generate a long-lived API token.
Option 1: Generate via API Call
```bash
curl -X POST http://your-proxmox-ip:8008/api/auth/generate-api-token
-H "Content-Type: application/json"
-d '{
"username": "your-username",
"password": "your-password",
"totp_token": "123456",
"token_name": "Homepage Integration"
}'
```
Response: ```json { "success": true, "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "token_name": "Homepage Integration", "expires_in": "365 days", "message": "API token generated successfully. Store this token securely, it will not be shown again." } ```
Notes:
- If 2FA is enabled, include the
totp_tokenfield with your 6-digit code - If 2FA is not enabled, omit the
totp_tokenfield - The token is valid for 365 days (1 year)
- Store the token securely - it cannot be retrieved again
Option 2: Generate via cURL (with 2FA)
```bash
With 2FA enabled
curl -X POST http://your-proxmox-ip:8008/api/auth/generate-api-token
-H "Content-Type: application/json"
-d '{"username":"pedro","password":"your-password","totp_token":"123456","token_name":"Home Assistant"}'
```
Option 3: Generate via cURL (without 2FA)
```bash
Without 2FA
curl -X POST http://your-proxmox-ip:8008/api/auth/generate-api-token
-H "Content-Type: application/json"
-d '{"username":"pedro","password":"your-password","token_name":"Homepage"}'
```
Using API Tokens
Once you have your API token, include it in the Authorization header of all API requests:
```bash
curl -H "Authorization: Bearer YOUR_API_TOKEN_HERE"
http://your-proxmox-ip:8008/api/system
```
Available Endpoints
Below is a complete list of all API endpoints with descriptions and example responses.
System & Metrics
| Endpoint | Method | Auth Required | Description |
|---|---|---|---|
/api/system |
GET | Yes | Complete system information (CPU, memory, temperature, uptime) |
/api/system-info |
GET | No | Lightweight system info for header (hostname, uptime, health) |
/api/node/metrics |
GET | Yes | Historical metrics data (RRD) for CPU, memory, disk I/O |
/api/prometheus |
GET | Yes | Export metrics in Prometheus format |
Example /api/system Response:
```json
{
"hostname": "pve",
"cpu_usage": 15.2,
"memory_usage": 45.8,
"temperature": 42.5,
"uptime": 345600,
"kernel": "6.2.16-3-pve",
"pve_version": "8.0.3"
}
```
Storage
| Endpoint | Method | Auth Required | Description |
|---|---|---|---|
/api/storage |
GET | Yes | Complete storage information with SMART data |
/api/storage/summary |
GET | Yes | Optimized storage summary (without SMART) |
/api/proxmox-storage |
GET | Yes | Proxmox storage pools information |
/api/backups |
GET | Yes | List of all backup files |
Example /api/storage/summary Response:
```json
{
"total_capacity": 1431894917120,
"used_space": 197414092800,
"free_space": 1234480824320,
"usage_percentage": 13.8,
"disks": [
{
"device": "/dev/sda",
"model": "Samsung SSD 970",
"size": "476.94 GB",
"type": "SSD"
}
]
}
```
Network
| Endpoint | Method | Auth Required | Description |
|---|---|---|---|
/api/network |
GET | Yes | Complete network information for all interfaces |
/api/network/summary |
GET | Yes | Optimized network summary |
/api/network/<interface>/metrics |
GET | Yes | Historical metrics (RRD) for specific interface |
Example /api/network/summary Response:
```json
{
"interfaces": [
{
"name": "vmbr0",
"ip": "192.168.1.100",
"state": "up",
"rx_bytes": 1234567890,
"tx_bytes": 987654321
}
]
}
```
Virtual Machines & Containers
| Endpoint | Method | Auth Required | Description |
|---|---|---|---|
/api/vms |
GET | Yes | List of all VMs and LXC containers |
/api/vms/<vmid> |
GET | Yes | Detailed configuration for specific VM/LXC |
/api/vms/<vmid>/metrics |
GET | Yes | Historical metrics (RRD) for specific VM/LXC |
/api/vms/<vmid>/logs |
GET | Yes | Download real logs for specific VM/LXC |
/api/vms/<vmid>/control |
POST | Yes | Control VM/LXC (start, stop, shutdown, reboot) |
/api/vms/<vmid>/config |
PUT | Yes | Update VM/LXC configuration (description/notes) |
Example /api/vms Response:
```json
{
"vms": [
{
"vmid": "100",
"name": "ubuntu-server",
"type": "qemu",
"status": "running",
"cpu": 2,
"maxcpu": 4,
"mem": 2147483648,
"maxmem": 4294967296,
"uptime": 86400
}
]
}
```
Hardware
| Endpoint | Method | Auth Required | Description |
|---|---|---|---|
/api/hardware |
GET | Yes | Complete hardware information (CPU, GPU, PCIe, disks) |
/api/gpu/<slot>/realtime |
GET | Yes | Real-time monitoring for specific GPU |
Example /api/hardware Response:
```json
{
"cpu": {
"model": "AMD Ryzen 9 5950X",
"cores": 16,
"threads": 32,
"frequency": "3.4 GHz"
},
"gpus": [
{
"slot": "0000:01:00.0",
"vendor": "NVIDIA",
"model": "GeForce RTX 3080",
"driver": "nvidia"
}
]
}
```
Logs, Events & Notifications
| Endpoint | Method | Auth Required | Description |
|---|---|---|---|
/api/logs |
GET | Yes | System logs (journalctl) with filters |
/api/logs/download |
GET | Yes | Download logs as text file |
/api/notifications |
GET | Yes | Proxmox notification history |
/api/notifications/download |
GET | Yes | Download full notification log |
/api/events |
GET | Yes | Recent Proxmox tasks and events |
/api/task-log/<upid> |
GET | Yes | Full log for specific task using UPID |
Example /api/logs Query Parameters:
```
/api/logs?severity=error&since=1h&search=failed
```
Health Monitoring
| Endpoint | Method | Auth Required | Description |
|---|---|---|---|
/api/health |
GET | No | Basic health check (for external monitoring) |
/api/health/status |
GET | Yes | Summary of system health status |
/api/health/details |
GET | Yes | Detailed health check results |
/api/health/acknowledge |
POST | Yes | Dismiss/acknowledge health warnings |
/api/health/active-errors |
GET | Yes | Get active persistent errors |
ProxMenux Optimizations
| Endpoint | Method | Auth Required | Description |
|---|---|---|---|
/api/proxmenux/installed-tools |
GET | Yes | List of installed ProxMenux optimizations |
Authentication
| Endpoint | Method | Auth Required | Description |
|---|---|---|---|
/api/auth/status |
GET | No | Current authentication status |
/api/auth/login |
POST | No | Authenticate and receive JWT token |
/api/auth/generate-api-token |
POST | No | Generate long-lived API token (365 days) |
/api/auth/setup |
POST | No | Initial setup of username/password |
/api/auth/enable |
POST | No | Enable authentication |
/api/auth/disable |
POST | Yes | Disable authentication |
/api/auth/change-password |
POST | No | Change password |
/api/auth/totp/setup |
POST | Yes | Initialize 2FA setup |
/api/auth/totp/enable |
POST | Yes | Enable 2FA after verification |
/api/auth/totp/disable |
POST | Yes | Disable 2FA |
Integration Examples
Homepage Integration
Homepage is a modern, fully static, fast, secure fully proxied, highly customizable application dashboard.
Basic Configuration (No Authentication)
```yaml
- ProxMenux Monitor: href: http://proxmox.example.tld:8008/ icon: lucide:flask-round widget: type: customapi url: http://proxmox.example.tld:8008/api/system refreshInterval: 10000 mappings: - field: uptime label: Uptime icon: lucide:clock-4 format: text - field: cpu_usage label: CPU icon: lucide:cpu format: percent - field: memory_usage label: RAM icon: lucide:memory-stick format: percent - field: temperature label: Temp icon: lucide:thermometer-sun format: number suffix: °C ```
With Authentication Enabled
First, generate an API token:
```bash
curl -X POST http://proxmox.example.tld:8008/api/auth/generate-api-token
-H "Content-Type: application/json"
-d '{
"username": "your-username",
"password": "your-password",
"token_name": "Homepage Integration"
}'
```
Then add the token to your Homepage configuration:
```yaml
- ProxMenux Monitor: href: http://proxmox.example.tld:8008/ icon: lucide:flask-round widget: type: customapi url: http://proxmox.example.tld:8008/api/system headers: Authorization: Bearer YOUR_API_TOKEN_HERE refreshInterval: 10000 mappings: - field: uptime label: Uptime icon: lucide:clock-4 format: text - field: cpu_usage label: CPU icon: lucide:cpu format: percent - field: memory_usage label: RAM icon: lucide:memory-stick format: percent - field: temperature label: Temp icon: lucide:thermometer-sun format: number suffix: °C ```
Advanced Multi-Widget Configuration
```yaml
-
ProxMenux System: href: http://proxmox.example.tld:8008/ icon: lucide:server description: Proxmox VE Host widget: type: customapi url: http://proxmox.example.tld:8008/api/system headers: Authorization: Bearer YOUR_API_TOKEN_HERE refreshInterval: 5000 mappings: - field: cpu_usage label: CPU icon: lucide:cpu format: percent - field: memory_usage label: RAM icon: lucide:memory-stick format: percent - field: temperature label: Temp icon: lucide:thermometer-sun format: number suffix: °C
-
ProxMenux Storage: href: http://proxmox.example.tld:8008/#/storage icon: lucide:hard-drive description: Storage Overview widget: type: customapi url: http://proxmox.example.tld:8008/api/storage/summary headers: Authorization: Bearer YOUR_API_TOKEN_HERE refreshInterval: 30000 mappings: - field: usage_percentage label: Used icon: lucide:database format: percent - field: used_space label: Space icon: lucide:folder format: bytes
-
ProxMenux Network: href: http://proxmox.example.tld:8008/#/network icon: lucide:network description: Network Stats widget: type: customapi url: http://proxmox.example.tld:8008/api/network/summary headers: Authorization: Bearer YOUR_API_TOKEN_HERE refreshInterval: 5000 mappings: - field: interfaces[0].rx_bytes label: Received icon: lucide:download format: bytes - field: interfaces[0].tx_bytes label: Sent icon: lucide:upload format: bytes ```
Home Assistant Integration
Home Assistant is an open-source home automation platform.
Configuration.yaml
```yaml
ProxMenux Monitor Sensors
sensor:
-
platform: rest name: ProxMenux CPU resource: http://proxmox.example.tld:8008/api/system headers: Authorization: Bearer YOUR_API_TOKEN_HERE value_template: "{{ value_json.cpu_usage }}" unit_of_measurement: "%" scan_interval: 30
-
platform: rest name: ProxMenux Memory resource: http://proxmox.example.tld:8008/api/system headers: Authorization: Bearer YOUR_API_TOKEN_HERE value_template: "{{ value_json.memory_usage }}" unit_of_measurement: "%" scan_interval: 30
-
platform: rest name: ProxMenux Temperature resource: http://proxmox.example.tld:8008/api/system headers: Authorization: Bearer YOUR_API_TOKEN_HERE value_template: "{{ value_json.temperature }}" unit_of_measurement: "°C" device_class: temperature scan_interval: 30
-
platform: rest name: ProxMenux Uptime resource: http://proxmox.example.tld:8008/api/system headers: Authorization: Bearer YOUR_API_TOKEN_HERE value_template: > {% set uptime_seconds = value_json.uptime | int %} {% set days = (uptime_seconds / 86400) | int %} {% set hours = ((uptime_seconds % 86400) / 3600) | int %} {% set minutes = ((uptime_seconds % 3600) / 60) | int %} {{ days }}d {{ hours }}h {{ minutes }}m scan_interval: 60 ```
Lovelace Card Example
```yaml type: entities title: Proxmox Monitor entities:
- entity: sensor.proxmenux_cpu name: CPU Usage icon: mdi:cpu-64-bit
- entity: sensor.proxmenux_memory name: Memory Usage icon: mdi:memory
- entity: sensor.proxmenux_temperature name: Temperature icon: mdi:thermometer
- entity: sensor.proxmenux_uptime name: Uptime icon: mdi:clock-outline ```
Onboarding Experience
ProxMenux Monitor includes an interactive onboarding carousel that introduces new users to the dashboard features.
Customizing Onboarding Images
To customize the onboarding screenshots, place your images in public/images/onboarding/:
imagen1.png- Overview section screenshotimagen2.png- Storage section screenshotimagen3.png- Network section screenshotimagen4.png- VMs & LXCs section screenshotimagen5.png- Hardware section screenshotimagen6.png- System Logs section screenshot
Recommended image specifications:
- Format: PNG or JPG
- Size: 1200x800px (or similar 3:2 aspect ratio)
- Quality: High-quality screenshots with representative data
The onboarding carousel appears on first visit and can be dismissed or marked as "Don't show again".
Contributing
Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.
Development Setup
- Clone the repository
- Install dependencies:
npm install - Run development server:
npm run dev - Build AppImage:
./build_appimage.sh
License
This project is licensed under the MIT License.
Support
For support, feature requests, or bug reports, please visit:
- GitHub Issues: github.com/your-repo/issues
- Documentation: github.com/your-repo/wiki
ProxMenux Monitor - Made with ❤️ for the Proxmox community