diff --git a/.env.example b/.env.example
index 0097efbbd..4da2d1688 100644
--- a/.env.example
+++ b/.env.example
@@ -1,5 +1,5 @@
-# ProxMox Node Configuration
-# Replace with your ProxMox node details
+# Proxmox VE Node Configuration
+# Replace with your Proxmox VE node details
# Node 1
PROXMOX_NODE_1_NAME=Proxmox Node 1
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index ca47f9922..f3243e729 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -27,7 +27,7 @@ If applicable, add screenshots to help explain your problem.
## Environment
- OS: [e.g. Ubuntu 22.04, Windows 11, macOS 13.0]
- Browser: [e.g. Chrome 108, Firefox 106]
-- ProxMox Version: [e.g. 7.3-3]
+- Proxmox VE Version: [e.g. 7.3-3]
- Pulse Version: [e.g. 1.2.1]
- Deployment Method: [e.g. Docker, Docker Compose]
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3bb19c3b8..02ee18e30 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
-# Contributing to ProxMox Pulse
+# Contributing to Pulse for Proxmox VE
-Thank you for considering contributing to ProxMox Pulse! This document outlines the process for contributing to the project.
+Thank you for considering contributing to Pulse for Proxmox VE! This document outlines the process for contributing to the project.
## Code of Conduct
@@ -31,8 +31,8 @@ This section guides you through submitting an enhancement suggestion, including
* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples.
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
-* **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of ProxMox Pulse which the suggestion is related to.
-* **Explain why this enhancement would be useful** to most ProxMox Pulse users.
+* **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of Pulse for Proxmox VE which the suggestion is related to.
+* **Explain why this enhancement would be useful** to most Pulse for Proxmox VE users.
* **List some other applications where this enhancement exists.**
### Pull Requests
@@ -79,4 +79,4 @@ This section guides you through submitting an enhancement suggestion, including
## License
-By contributing to ProxMox Pulse, you agree that your contributions will be licensed under the project's [MIT License](LICENSE).
\ No newline at end of file
+By contributing to Pulse for Proxmox VE, you agree that your contributions will be licensed under the project's [MIT License](LICENSE).
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
index 65a6f0a3b..92edf18c1 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -23,7 +23,7 @@ FROM node:18-slim
# Add version labels
LABEL version="1.3.0"
-LABEL description="ProxMox Pulse - A lightweight monitoring application for ProxMox"
+LABEL description="Pulse - A lightweight monitoring application for Proxmox VE"
LABEL maintainer="Richard Courtman"
# Create a non-root user
diff --git a/docs/SCREENSHOTS.md b/docs/SCREENSHOTS.md
index 179d0d5b9..f52eed27f 100644
--- a/docs/SCREENSHOTS.md
+++ b/docs/SCREENSHOTS.md
@@ -1,4 +1,4 @@
-# Screenshot Automation for ProxMox Pulse
+# Screenshot Automation for Pulse for Proxmox VE
This document explains how to use the screenshot automation tool to keep the documentation images up-to-date with the latest UI changes.
diff --git a/frontend/index.html b/frontend/index.html
index 9ae85050a..b384ab93a 100644
--- a/frontend/index.html
+++ b/frontend/index.html
@@ -4,8 +4,8 @@
-
-
Pulse
+
+ Pulse for Proxmox VE
diff --git a/package.json b/package.json
index be6672260..264f7292a 100644
--- a/package.json
+++ b/package.json
@@ -27,7 +27,7 @@
],
"author": "Richard Courtman",
"license": "MIT",
- "description": "A lightweight, responsive ProxMox monitoring application that displays real-time metrics for CPU, memory, network, and disk usage across multiple nodes.",
+ "description": "A lightweight, responsive monitoring application for Proxmox VE that displays real-time metrics for CPU, memory, network, and disk usage across multiple nodes.",
"repository": {
"type": "git",
"url": "git+https://github.com/rcourtman/pulse.git"
diff --git a/scripts/update-screenshots.sh b/scripts/update-screenshots.sh
index 9c1d7d2fe..52ef1af4a 100755
--- a/scripts/update-screenshots.sh
+++ b/scripts/update-screenshots.sh
@@ -1,6 +1,6 @@
#!/bin/bash
-# ProxMox Pulse Screenshot Generator
+# Pulse for Proxmox VE Screenshot Generator
# Automates the process of generating screenshots for documentation
# by starting required servers with mock data and running the screenshot tool.
diff --git a/src/api/proxmox/events.ts b/src/api/proxmox/events.ts
index 5c641e015..f019b5191 100644
--- a/src/api/proxmox/events.ts
+++ b/src/api/proxmox/events.ts
@@ -29,7 +29,7 @@ export async function subscribeToEvents(this: ProxmoxClient, callback: (event: P
}
// Set up polling interval - this is a fallback method
- // ProxMox doesn't have a true WebSocket event API, but we can optimize our polling
+ // Proxmox doesn't have a true WebSocket event API, but we can optimize our polling
// to be more responsive and efficient
let isPolling = false;
diff --git a/src/api/proxmox/guests.ts b/src/api/proxmox/guests.ts
index 9bbbc78db..391c8eb30 100644
--- a/src/api/proxmox/guests.ts
+++ b/src/api/proxmox/guests.ts
@@ -138,7 +138,7 @@ export async function getContainers(this: ProxmoxClient): Promise {
@@ -116,7 +116,7 @@ export class ProxmoxClient extends EventEmitter implements ProxmoxClientMethods
setupEventPolling(): void { throw new Error('Not implemented'); }
/**
- * Test the connection to the ProxMox API
+ * Test the connection to the Proxmox API
*/
async testConnection(): Promise {
try {
diff --git a/src/api/proxmox/node-discovery.ts b/src/api/proxmox/node-discovery.ts
index 1e1c03583..f05f4bdce 100644
--- a/src/api/proxmox/node-discovery.ts
+++ b/src/api/proxmox/node-discovery.ts
@@ -1,7 +1,7 @@
import { ProxmoxClient } from './index';
/**
- * Discover the actual ProxMox node name
+ * Discover the actual Proxmox node name
*/
export async function discoverNodeName(this: ProxmoxClient): Promise {
// If we already discovered the node name, return it
@@ -88,16 +88,8 @@ export async function getNodeNameAsync(this: ProxmoxClient): Promise {
* Get node name (legacy method, will be deprecated)
*/
export function getNodeName(this: ProxmoxClient): string {
- // In ProxMox, the node name is typically the hostname of the server
- // We'll try to get it from the API, but for now use a hardcoded value based on the node ID
- // This assumes your node IDs in the config match the actual ProxMox node names
- if (this.config.id === 'node-1') {
- return 'pve'; // Typical default name for the first node in a ProxMox cluster
- } else if (this.config.id === 'node-2') {
- return 'pve2'; // Typical name for the second node
- }
-
- // Fallback to the old method if we can't determine the node name
- const url = new URL(this.config.host);
- return url.hostname;
+ // In Proxmox, the node name is typically the hostname of the server
+ // This assumes your node IDs in the config match the actual Proxmox node names
+ // If not found, return 'pve' which is the typical default name for the first node in a Proxmox cluster
+ return 'pve';
}
\ No newline at end of file
diff --git a/src/config/index.ts b/src/config/index.ts
index a917c4a62..d076fa940 100644
--- a/src/config/index.ts
+++ b/src/config/index.ts
@@ -80,7 +80,7 @@ function parseNodeConfigs(): NodeConfig[] {
function validateConfig(config: AppConfig): void {
// Check if at least one node is configured
if (config.nodes.length === 0) {
- throw new Error('No valid ProxMox nodes configured. Please check your environment variables.');
+ throw new Error('No valid Proxmox VE nodes configured. Please check your environment variables.');
}
// Validate port
diff --git a/src/services/metrics-service.ts b/src/services/metrics-service.ts
index 2d1da457d..47876a7ef 100644
--- a/src/services/metrics-service.ts
+++ b/src/services/metrics-service.ts
@@ -133,7 +133,7 @@ export class MetricsService extends EventEmitter {
guestId,
type,
metrics: {
- // ProxMox returns CPU as a decimal (e.g., 0.0854 for 8.54%)
+ // Proxmox returns CPU as a decimal (e.g., 0.0854 for 8.54%)
// We need to multiply by 100 to get the percentage
cpu: guest.cpu !== undefined ? guest.cpu * 100 : (guest.cpus > 0 ? 0 : 0),
memory: {
diff --git a/src/services/node-manager.ts b/src/services/node-manager.ts
index 950309ae1..712ad05e6 100644
--- a/src/services/node-manager.ts
+++ b/src/services/node-manager.ts
@@ -240,7 +240,7 @@ export class NodeManager extends EventEmitter {
}
/**
- * Handle event from ProxMox
+ * Handle event from Proxmox
*/
private handleEvent(nodeId: string, event: ProxmoxEvent): void {
// Only process important events
diff --git a/src/utils/config-validator.ts b/src/utils/config-validator.ts
index bbc424baf..b3d1e7f06 100644
--- a/src/utils/config-validator.ts
+++ b/src/utils/config-validator.ts
@@ -80,7 +80,7 @@ async function validateNodeConfig(nodeConfig: NodeConfig, ignoreSSLErrors: boole
// Test connection
const response = await client.get('/version');
- logger.info(`Node ${nodeConfig.id}: Successfully connected to ProxMox API version ${response.data.data.version}`);
+ logger.info(`Node ${nodeConfig.id}: Successfully connected to Proxmox API version ${response.data.data.version}`);
return true;
} catch (error) {
if (axios.isAxiosError(error)) {
@@ -129,9 +129,9 @@ export async function validateAndLogHelp(config: AppConfig): Promise {
if (!isValid) {
logger.info('Configuration validation failed. Here are some troubleshooting tips:');
- logger.info('1. Check network connectivity to the ProxMox nodes');
- logger.info('2. Verify that the API tokens have the correct permissions');
- logger.info('3. Make sure the ProxMox API is accessible on the specified port');
+ logger.info('1. Check network connectivity to the Proxmox nodes');
+ logger.info('2. Verify your API token has the correct permissions (PVEAuditor role)');
+ logger.info('3. Make sure the Proxmox API is accessible on the specified port');
logger.info('4. Check for special characters in token IDs that might need escaping');
// Generate curl examples for each node
diff --git a/src/websocket/index.ts b/src/websocket/index.ts
index 9c7cb0a0f..948eb9819 100644
--- a/src/websocket/index.ts
+++ b/src/websocket/index.ts
@@ -132,7 +132,7 @@ export class WebSocketServer {
// Send connected message
socket.emit('message', this.createMessage(WebSocketMessageType.CONNECTED, {
timestamp: Date.now(),
- message: 'Connected to ProxMox Monitor WebSocket server'
+ message: 'Connected to Pulse for Proxmox VE WebSocket server'
}));
// Send all nodes
diff --git a/tools/screenshot-automation/README.md b/tools/screenshot-automation/README.md
index 59f75feee..17c835765 100644
--- a/tools/screenshot-automation/README.md
+++ b/tools/screenshot-automation/README.md
@@ -1,6 +1,6 @@
-# ProxMox Pulse Screenshot Automation Tool
+# Screenshot Automation Tool for Pulse for Proxmox VE
-This tool automates the process of taking screenshots for the ProxMox Pulse application documentation. It can capture screenshots in both light and dark modes, create split-view images, and crop specific regions of the UI.
+This tool automates the process of taking screenshots for the Pulse for Proxmox VE application documentation. It can capture screenshots in both light and dark modes, create split-view images, and crop specific regions of the UI.
## Features
diff --git a/tools/screenshot-automation/cli.ts b/tools/screenshot-automation/cli.ts
index e4ead871a..8cbb9f588 100644
--- a/tools/screenshot-automation/cli.ts
+++ b/tools/screenshot-automation/cli.ts
@@ -8,7 +8,7 @@ import { logger } from './logger';
// Set up command line interface
program
.name('screenshot-tool')
- .description('Automated screenshot tool for ProxMox Pulse')
+ .description('Automated screenshot tool for Pulse for Proxmox VE')
.version('1.0.0')
.option('-c, --config ', 'Path to config file', './screenshot-config.json')
.option('-u, --url ', 'Base URL to use (overrides config file)')
diff --git a/tools/screenshot-automation/package.json b/tools/screenshot-automation/package.json
index fb7f7d791..2de260c0e 100644
--- a/tools/screenshot-automation/package.json
+++ b/tools/screenshot-automation/package.json
@@ -1,7 +1,7 @@
{
"name": "pulse-screenshot-tool",
"version": "1.0.0",
- "description": "Automated screenshot tool for ProxMox Pulse",
+ "description": "Automated screenshot tool for Pulse for Proxmox VE",
"main": "dist/cli.js",
"bin": {
"pulse-screenshots": "dist/cli.js"
diff --git a/tools/screenshot-automation/update-screenshots.sh b/tools/screenshot-automation/update-screenshots.sh
index 8229923f7..72d154704 100755
--- a/tools/screenshot-automation/update-screenshots.sh
+++ b/tools/screenshot-automation/update-screenshots.sh
@@ -1,6 +1,6 @@
#!/bin/bash
-# Update Screenshots Script for ProxMox Pulse
+# Update Screenshots Script for Pulse for Proxmox VE
# This script automates the process of taking screenshots for documentation
# Set default values