Add Pulse LXC script and JSON definition
This commit is contained in:
courtmanr@gmail.com
parent
80ac6e726b
commit
8bce4aa4c1
193
ct/pulse.sh
Normal file
193
ct/pulse.sh
Normal file
@ -0,0 +1,193 @@
|
||||
#!/usr/bin/env bash
|
||||
source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func)
|
||||
# Copyright (c) 2021-2025 community-scripts ORG
|
||||
# Author: rcourtman
|
||||
# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
|
||||
# Source: https://github.com/rcourtman/Pulse
|
||||
|
||||
# App Default Values
|
||||
APP="Pulse"
|
||||
# shellcheck disable=SC2034
|
||||
var_tags="monitoring;nodejs"
|
||||
# shellcheck disable=SC2034
|
||||
var_cpu="1"
|
||||
# shellcheck disable=SC2034
|
||||
var_ram="1024"
|
||||
# shellcheck disable=SC2034
|
||||
var_disk="4"
|
||||
# shellcheck disable=SC2034
|
||||
var_os="debian"
|
||||
# shellcheck disable=SC2034
|
||||
var_version="12"
|
||||
# shellcheck disable=SC2034
|
||||
var_unprivileged="1"
|
||||
|
||||
header_info "$APP"
|
||||
variables
|
||||
color
|
||||
catch_errors
|
||||
|
||||
function update_script() {
|
||||
header_info
|
||||
check_container_storage
|
||||
check_container_resources
|
||||
|
||||
# Check if installation is present
|
||||
if [[ ! -d /opt/pulse-proxmox/.git ]]; then
|
||||
msg_error "No ${APP} Installation Found! Cannot check/update via git."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if jq is installed (needed for version parsing)
|
||||
if ! command -v jq &>/dev/null; then
|
||||
msg_error "jq is required for version checking but not installed. Please install it (apt-get install jq)."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Crawling the new version and checking whether an update is required
|
||||
msg_info "Checking for ${APP} updates..."
|
||||
LATEST_RELEASE=$(curl -s https://api.github.com/repos/rcourtman/Pulse/releases/latest | jq -r '.tag_name')
|
||||
if ! LATEST_RELEASE=$(curl -s https://api.github.com/repos/rcourtman/Pulse/releases/latest | jq -r '.tag_name') ||
|
||||
[[ -z "$LATEST_RELEASE" ]] || [[ "$LATEST_RELEASE" == "null" ]]; then
|
||||
msg_error "Failed to fetch latest release information from GitHub API."
|
||||
exit 1
|
||||
fi
|
||||
msg_ok "Latest available version: ${LATEST_RELEASE}"
|
||||
|
||||
CURRENT_VERSION=""
|
||||
if [[ -f /opt/${APP}_version.txt ]]; then
|
||||
CURRENT_VERSION=$(cat /opt/${APP}_version.txt)
|
||||
else
|
||||
msg_warning "Version file /opt/${APP}_version.txt not found. Cannot determine current version. Will attempt update."
|
||||
fi
|
||||
|
||||
if [[ "${LATEST_RELEASE}" != "$CURRENT_VERSION" ]] || [[ ! -f /opt/${APP}_version.txt ]]; then
|
||||
msg_info "Updating ${APP} to ${LATEST_RELEASE}..."
|
||||
|
||||
# Stopping Service
|
||||
msg_info "Stopping ${APP} service..."
|
||||
systemctl stop pulse-monitor.service
|
||||
msg_ok "Stopped ${APP} service."
|
||||
|
||||
# Execute Update using git and npm (run as root, chown later)
|
||||
msg_info "Fetching and checking out ${LATEST_RELEASE}..."
|
||||
cd /opt/pulse-proxmox || {
|
||||
msg_error "Failed to cd into /opt/pulse-proxmox"
|
||||
exit 1
|
||||
}
|
||||
|
||||
msg_info "Configuring git safe directory..."
|
||||
set -x # Enable command tracing
|
||||
# Allow root user to operate on the pulse user's git repo - exit if it fails
|
||||
git config --global --add safe.directory /opt/pulse-proxmox
|
||||
local git_config_exit_code=$? # Capture exit code
|
||||
set +x # Disable command tracing
|
||||
if [ $git_config_exit_code -ne 0 ]; then
|
||||
msg_error "git config safe.directory failed with exit code $git_config_exit_code"
|
||||
exit 1
|
||||
fi
|
||||
msg_ok "Configured git safe directory."
|
||||
|
||||
# Reset local changes, fetch, checkout, clean
|
||||
# Use silent function wrapper for non-interactive update
|
||||
silent git fetch origin --tags --force || {
|
||||
msg_error "Failed to fetch from git remote."
|
||||
exit 1
|
||||
}
|
||||
echo "DEBUG: Attempting checkout command: git checkout ${LATEST_RELEASE}" # DEBUG
|
||||
# Try checkout without -f and without silent wrapper
|
||||
git checkout "${LATEST_RELEASE}" || {
|
||||
msg_error "Failed to checkout tag ${LATEST_RELEASE}."
|
||||
exit 1
|
||||
}
|
||||
silent git reset --hard "${LATEST_RELEASE}" || {
|
||||
msg_error "Failed to reset to tag ${LATEST_RELEASE}."
|
||||
exit 1
|
||||
}
|
||||
silent git clean -fd || { msg_warning "Failed to clean untracked files."; } # Non-fatal warning
|
||||
msg_ok "Fetched and checked out ${LATEST_RELEASE}."
|
||||
|
||||
msg_info "Setting ownership and permissions before npm install..."
|
||||
chown -R pulse:pulse /opt/pulse-proxmox || {
|
||||
msg_error "Failed to chown /opt/pulse-proxmox"
|
||||
exit 1
|
||||
}
|
||||
# Ensure correct execute permissions before npm install/build
|
||||
chmod -R u+rwX,go+rX,go-w /opt/pulse-proxmox || {
|
||||
msg_error "Failed to chmod /opt/pulse-proxmox"
|
||||
exit 1
|
||||
}
|
||||
# Explicitly add execute permission for node_modules binaries
|
||||
if [ -d "/opt/pulse-proxmox/node_modules/.bin" ]; then
|
||||
chmod +x /opt/pulse-proxmox/node_modules/.bin/* || msg_warning "Failed to chmod +x on node_modules/.bin"
|
||||
fi
|
||||
msg_ok "Ownership and permissions set."
|
||||
|
||||
msg_info "Installing Node.js dependencies..."
|
||||
# Run installs as pulse user with simulated login shell, ensuring correct directory
|
||||
silent sudo -iu pulse sh -c 'cd /opt/pulse-proxmox && npm install --unsafe-perm' || {
|
||||
msg_error "Failed to install root npm dependencies."
|
||||
exit 1
|
||||
}
|
||||
# Install server deps
|
||||
# Explicitly set directory for server deps install as well
|
||||
silent sudo -iu pulse sh -c 'cd /opt/pulse-proxmox/server && npm install --unsafe-perm' || {
|
||||
msg_error "Failed to install server npm dependencies."
|
||||
exit 1
|
||||
}
|
||||
# No need for cd .. here as sh -c runs in a subshell
|
||||
msg_ok "Node.js dependencies installed."
|
||||
|
||||
msg_info "Building CSS assets..."
|
||||
# Try running tailwindcss directly as pulse user, specifying full path
|
||||
TAILWIND_PATH="/opt/pulse-proxmox/node_modules/.bin/tailwindcss"
|
||||
TAILWIND_ARGS="-c ./src/tailwind.config.js -i ./src/index.css -o ./src/public/output.css"
|
||||
# Use sh -c to ensure correct directory context for paths in TAILWIND_ARGS
|
||||
if ! sudo -iu pulse sh -c "cd /opt/pulse-proxmox && $TAILWIND_PATH $TAILWIND_ARGS"; then
|
||||
# Use echo directly, remove BFR
|
||||
echo -e "${TAB}${YW}⚠️ Failed to build CSS assets (See errors above). Proceeding anyway.${CL}"
|
||||
else
|
||||
msg_ok "CSS assets built."
|
||||
fi
|
||||
|
||||
msg_info "Setting permissions..."
|
||||
# Permissions might not be strictly needed now if installs run as pulse,
|
||||
# but doesn't hurt to ensure consistency.
|
||||
# Run chown again to be safe, though maybe less critical now.
|
||||
chown -R pulse:pulse /opt/pulse-proxmox || msg_warning "Final chown failed."
|
||||
# Final chmod removed as it's done earlier
|
||||
msg_ok "Permissions set."
|
||||
|
||||
# Starting Service
|
||||
msg_info "Starting ${APP} service..."
|
||||
systemctl start pulse-monitor.service
|
||||
msg_ok "Started ${APP} service."
|
||||
|
||||
# Update version file
|
||||
echo "${LATEST_RELEASE}" >/opt/${APP}_version.txt
|
||||
msg_ok "Update Successful to ${LATEST_RELEASE}"
|
||||
else
|
||||
msg_ok "No update required. ${APP} is already at ${LATEST_RELEASE}."
|
||||
fi
|
||||
exit 0
|
||||
}
|
||||
|
||||
start
|
||||
build_container
|
||||
description
|
||||
|
||||
# Read port from .env file if it exists, otherwise use default
|
||||
PULSE_PORT=7655 # Default
|
||||
if [ -f "/opt/pulse-proxmox/.env" ] && grep -q '^PORT=' "/opt/pulse-proxmox/.env"; then
|
||||
PULSE_PORT=$(grep '^PORT=' "/opt/pulse-proxmox/.env" | cut -d'=' -f2 | tr -d '[:space:]')
|
||||
# Basic validation if port looks like a number
|
||||
if ! [[ "$PULSE_PORT" =~ ^[0-9]+$ ]]; then
|
||||
PULSE_PORT=7655 # Fallback to default if not a number
|
||||
fi
|
||||
fi
|
||||
|
||||
msg_ok "Completed Successfully!
|
||||
"
|
||||
echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"
|
||||
echo -e "${INFO}${YW} Access it using the following URL:${CL}"
|
||||
echo -e "${TAB}${GATEWAY}${BGN}http://${IP}:${PULSE_PORT}${CL}"
|
||||
197
install/pulse-install.sh
Normal file
197
install/pulse-install.sh
Normal file
@ -0,0 +1,197 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Copyright (c) 2021-2025 community-scripts ORG
|
||||
# Author: rcourtman
|
||||
# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
|
||||
# Source: https://github.com/rcourtman/Pulse
|
||||
|
||||
# Import Functions and Setup
|
||||
source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
|
||||
|
||||
color
|
||||
verb_ip6
|
||||
catch_errors
|
||||
setting_up_container
|
||||
network_check
|
||||
update_os
|
||||
|
||||
# --- Configuration ---
|
||||
APP="Pulse"
|
||||
APP_DIR="/opt/pulse-proxmox"
|
||||
PULSE_USER="pulse"
|
||||
SERVICE_NAME="pulse-monitor.service"
|
||||
NODE_MAJOR_VERSION=20 # From install-pulse.sh
|
||||
REPO_URL="https://github.com/rcourtman/Pulse.git"
|
||||
|
||||
# Create Pulse User
|
||||
msg_info "Creating dedicated user '${PULSE_USER}'..."
|
||||
if id "$PULSE_USER" &>/dev/null; then
|
||||
msg_warning "User '${PULSE_USER}' already exists. Skipping creation."
|
||||
else
|
||||
useradd -r -m -d /opt/pulse-home -s /bin/bash "$PULSE_USER" # Give a shell for potential debugging/manual commands
|
||||
if useradd -r -m -d /opt/pulse-home -s /bin/bash "$PULSE_USER"; then
|
||||
msg_ok "User '${PULSE_USER}' created successfully."
|
||||
else
|
||||
msg_error "Failed to create user '${PULSE_USER}'."
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Installing Dependencies
|
||||
msg_info "Installing Dependencies (git, curl, sudo, gpg, jq, diffutils)..."
|
||||
$STD apt-get install -y \
|
||||
git \
|
||||
curl \
|
||||
sudo \
|
||||
gpg \
|
||||
jq \
|
||||
diffutils
|
||||
msg_ok "Installed Core Dependencies"
|
||||
|
||||
# Setup Node.js via NodeSource
|
||||
msg_info "Setting up Node.js ${NODE_MAJOR_VERSION}.x repository..."
|
||||
KEYRING_DIR="/usr/share/keyrings"
|
||||
KEYRING_FILE="$KEYRING_DIR/nodesource.gpg"
|
||||
mkdir -p "$KEYRING_DIR"
|
||||
curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --yes --dearmor -o "$KEYRING_FILE"
|
||||
pipestatus=("${PIPESTATUS[@]}") # Capture pipestatus array
|
||||
if [ "${pipestatus[1]}" -ne 0 ]; then
|
||||
msg_error "Failed to download NodeSource GPG key (gpg exited non-zero)."
|
||||
exit 1
|
||||
fi
|
||||
if [ "${pipestatus[0]}" -ne 0 ]; then msg_warning "Curl failed to download GPG key (curl exited non-zero), but gpg seemed okay? Proceeding cautiously."; fi
|
||||
echo "deb [signed-by=$KEYRING_FILE] https://deb.nodesource.com/node_$NODE_MAJOR_VERSION.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list >/dev/null
|
||||
msg_info "Updating package list after adding NodeSource..."
|
||||
$STD apt-get update
|
||||
msg_info "Installing Node.js ${NODE_MAJOR_VERSION}.x..."
|
||||
$STD apt-get install -y nodejs
|
||||
msg_ok "Installed Node.js"
|
||||
msg_info "Node version: $(node -v)"
|
||||
msg_info "npm version: $(npm -v)"
|
||||
|
||||
# Setup App
|
||||
msg_info "Cloning ${APP} repository..."
|
||||
# Clone as root initially, then change ownership
|
||||
$STD git clone "$REPO_URL" "$APP_DIR"
|
||||
cd "$APP_DIR" || {
|
||||
msg_error "Failed to cd into $APP_DIR"
|
||||
exit 1
|
||||
}
|
||||
msg_ok "Cloned ${APP} repository."
|
||||
|
||||
msg_info "Fetching latest release tag..."
|
||||
LATEST_RELEASE=$(curl -s https://api.github.com/repos/rcourtman/Pulse/releases/latest | jq -r '.tag_name')
|
||||
pipestatus=("${PIPESTATUS[@]}")
|
||||
if [ "${pipestatus[0]}" -ne 0 ] || [ "${pipestatus[1]}" -ne 0 ] ||
|
||||
[[ -z "$LATEST_RELEASE" ]] || [[ "$LATEST_RELEASE" == "null" ]]; then
|
||||
msg_warning "Failed to fetch latest release tag. Proceeding with default branch."
|
||||
# Optionally, you could fetch tags via git and parse locally:
|
||||
# LATEST_RELEASE=$(git tag -l 'v*' --sort='-version:refname' | head -n 1)
|
||||
# if [[ -z "$LATEST_RELEASE" ]]; then msg_error "Could not find any release tags."; exit 1; fi
|
||||
else
|
||||
msg_info "Checking out latest release tag: ${LATEST_RELEASE}"
|
||||
$STD git checkout "${LATEST_RELEASE}"
|
||||
msg_ok "Checked out ${LATEST_RELEASE}."
|
||||
fi
|
||||
|
||||
# Install npm dependencies (as root because of /opt permissions)
|
||||
msg_info "Installing Node.js dependencies for ${APP}..."
|
||||
# Install root deps (includes dev for build)
|
||||
$STD npm install --unsafe-perm
|
||||
# Install server deps
|
||||
cd server || {
|
||||
msg_error "Failed to cd into server directory."
|
||||
exit 1
|
||||
}
|
||||
$STD npm install --unsafe-perm
|
||||
cd ..
|
||||
msg_ok "Installed Node.js dependencies."
|
||||
|
||||
# Build CSS
|
||||
msg_info "Building CSS assets..."
|
||||
$STD npm run build:css
|
||||
msg_ok "Built CSS assets."
|
||||
|
||||
# Configure Environment (.env)
|
||||
msg_info "Configuring environment file..."
|
||||
ENV_EXAMPLE="${APP_DIR}/.env.example"
|
||||
ENV_FILE="${APP_DIR}/.env"
|
||||
if [ -f "$ENV_EXAMPLE" ]; then
|
||||
# Copy example to .env if .env doesn't exist or is empty
|
||||
if [ ! -s "$ENV_FILE" ]; then
|
||||
cp "$ENV_EXAMPLE" "$ENV_FILE"
|
||||
msg_info "Created ${ENV_FILE} from example."
|
||||
# Set default values (or leave placeholders for user to fill)
|
||||
# Using defaults similar to install-pulse.sh prompts
|
||||
sed -i 's|^PROXMOX_HOST=.*|PROXMOX_HOST=https://proxmox_host:8006|' "$ENV_FILE"
|
||||
sed -i 's|^PROXMOX_TOKEN_ID=.*|PROXMOX_TOKEN_ID=user@pam!tokenid|' "$ENV_FILE"
|
||||
sed -i 's|^PROXMOX_TOKEN_SECRET=.*|PROXMOX_TOKEN_SECRET=YOUR_API_SECRET_HERE|' "$ENV_FILE"
|
||||
sed -i 's|^PROXMOX_ALLOW_SELF_SIGNED_CERTS=.*|PROXMOX_ALLOW_SELF_SIGNED_CERTS=true|' "$ENV_FILE"
|
||||
sed -i 's|^PORT=.*|PORT=7655|' "$ENV_FILE"
|
||||
msg_warning "${ENV_FILE} created with placeholder values. Please edit it with your Proxmox details!"
|
||||
else
|
||||
msg_warning "${ENV_FILE} already exists. Skipping default configuration."
|
||||
fi
|
||||
# Set permissions on .env regardless
|
||||
chmod 600 "$ENV_FILE"
|
||||
else
|
||||
msg_warning "${ENV_EXAMPLE} not found. Skipping environment configuration."
|
||||
fi
|
||||
|
||||
# Set Permissions for the entire app directory
|
||||
msg_info "Setting permissions for ${APP_DIR}..."
|
||||
chown -R ${PULSE_USER}:${PULSE_USER} "${APP_DIR}"
|
||||
# Ensure pulse user can write to logs if needed, and execute necessary files
|
||||
find "${APP_DIR}" -type d -exec chmod 755 {} \;
|
||||
find "${APP_DIR}" -type f -exec chmod 644 {} \;
|
||||
# Make sure node_modules executables are runnable if needed (though npm scripts handle this)
|
||||
# chmod +x ${APP_DIR}/server/server.js # Example if direct execution was needed
|
||||
chmod 600 "$ENV_FILE" # Ensure .env is kept restricted
|
||||
msg_ok "Set permissions."
|
||||
|
||||
# Save Installed Version
|
||||
msg_info "Saving installed version information..."
|
||||
VERSION_TO_SAVE="${LATEST_RELEASE:-$(git rev-parse --short HEAD)}" # Use tag or commit hash
|
||||
echo "${VERSION_TO_SAVE}" >/opt/${APP}_version.txt
|
||||
msg_ok "Saved version info (${VERSION_TO_SAVE})."
|
||||
|
||||
# Creating Service
|
||||
msg_info "Creating systemd service for ${APP}..."
|
||||
NODE_PATH=$(command -v node)
|
||||
NPM_PATH=$(command -v npm)
|
||||
cat <<EOF >/etc/systemd/system/${SERVICE_NAME}
|
||||
[Unit]
|
||||
Description=${APP} Monitoring Application
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=${PULSE_USER}
|
||||
Group=${PULSE_USER}
|
||||
WorkingDirectory=${APP_DIR}
|
||||
EnvironmentFile=${APP_DIR}/.env
|
||||
# Use absolute paths for node and npm
|
||||
ExecStart=${NODE_PATH} ${NPM_PATH} run start
|
||||
Restart=on-failure
|
||||
RestartSec=5
|
||||
StandardOutput=journal
|
||||
StandardError=journal
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
EOF
|
||||
systemctl enable -q --now ${SERVICE_NAME}
|
||||
msg_ok "Created and enabled systemd service."
|
||||
|
||||
# Add motd and customize (standard functions)
|
||||
motd_ssh
|
||||
customize
|
||||
|
||||
# Cleanup
|
||||
msg_info "Cleaning up apt cache..."
|
||||
$STD apt-get -y autoremove
|
||||
$STD apt-get -y autoclean
|
||||
msg_ok "Cleaned up."
|
||||
|
||||
# Sentinel file for ct script verification (optional but good practice)
|
||||
touch /opt/pulse_install_complete
|
||||
34
json/pulse.json
Normal file
34
json/pulse.json
Normal file
@ -0,0 +1,34 @@
|
||||
{
|
||||
"name": "Pulse",
|
||||
"slug": "pulse",
|
||||
"categories": [
|
||||
9
|
||||
],
|
||||
"date_created": "2024-07-26",
|
||||
"type": "ct",
|
||||
"updateable": true,
|
||||
"privileged": false,
|
||||
"interface_port": 7655,
|
||||
"documentation": null,
|
||||
"website": "https://github.com/rcourtman/Pulse",
|
||||
"logo": "https://raw.githubusercontent.com/rcourtman/Pulse/main/src/public/logos/pulse-logo-256x256.png",
|
||||
"description": "A lightweight monitoring application for Proxmox VE that displays real-time status for VMs and containers via a simple web interface.",
|
||||
"install_methods": [
|
||||
{
|
||||
"type": "default",
|
||||
"script": "ct/pulse.sh",
|
||||
"resources": {
|
||||
"cpu": 2,
|
||||
"ram": 2048,
|
||||
"hdd": 4,
|
||||
"os": "debian",
|
||||
"version": "12"
|
||||
}
|
||||
}
|
||||
],
|
||||
"default_credentials": {
|
||||
"username": null,
|
||||
"password": null
|
||||
},
|
||||
"notes": []
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user