diff --git a/ct/pulse.sh b/ct/pulse.sh new file mode 100644 index 0000000..3b16d49 --- /dev/null +++ b/ct/pulse.sh @@ -0,0 +1,153 @@ +#!/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="Pulse" +var_tags="monitoring;nodejs" +var_cpu="1" +var_ram="1024" +var_disk="4" +var_os="debian" +var_version="12" +var_unprivileged="1" + +header_info "$APP" +variables +color +catch_errors + +function update_script() { + header_info + check_container_storage + check_container_resources + + if ! command -v jq &>/dev/null; then + msg_info "jq is not installed. Installing..." + $STD apt-get update >/dev/null + $STD apt-get install -y jq >/dev/null + if ! command -v jq &>/dev/null; then + msg_error "Failed to install jq. Cannot proceed with update check." + exit 1 + fi + msg_ok "jq installed." + fi + + msg_info "Checking for ${APP} updates..." + LATEST_RELEASE=$(curl -s https://api.github.com/repos/rcourtman/Pulse/releases/latest | jq -r '.tag_name') + msg_ok "Latest available version: ${LATEST_RELEASE}" + + CURRENT_VERSION="" + if [[ -f /opt/${APP}_version.txt ]]; then + CURRENT_VERSION=$(cat /opt/${APP}_version.txt) + fi + + if [[ "${LATEST_RELEASE}" != "$CURRENT_VERSION" ]] || [[ ! -f /opt/${APP}_version.txt ]]; then + msg_info "Updating ${APP} to ${LATEST_RELEASE}..." + + msg_info "Stopping ${APP} service..." + systemctl stop pulse-monitor.service + msg_ok "Stopped ${APP} service." + + 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 + git config --global --add safe.directory /opt/pulse-proxmox + local git_config_exit_code=$? + set +x + 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." + + 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}" + 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."; } + 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 + } + chmod -R u+rwX,go+rX,go-w /opt/pulse-proxmox || { + msg_error "Failed to chmod /opt/pulse-proxmox" + exit 1 + } + 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..." + silent sudo -iu pulse sh -c 'cd /opt/pulse-proxmox && npm install --unsafe-perm' || { + msg_error "Failed to install root npm dependencies." + exit 1 + } + 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 + } + msg_ok "Node.js dependencies installed." + + msg_info "Building CSS assets..." + 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" + if ! sudo -iu pulse sh -c "cd /opt/pulse-proxmox && $TAILWIND_PATH $TAILWIND_ARGS"; then + 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..." + chown -R pulse:pulse /opt/pulse-proxmox || msg_warning "Final chown failed." + msg_ok "Permissions set." + + msg_info "Starting ${APP} service..." + systemctl start pulse-monitor.service + msg_ok "Started ${APP} service." + + 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 + +PULSE_PORT=7655 +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:]') + if ! [[ "$PULSE_PORT" =~ ^[0-9]+$ ]]; then + PULSE_PORT=7655 + 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}" diff --git a/install/pulse-install.sh b/install/pulse-install.sh new file mode 100644 index 0000000..7acbd4a --- /dev/null +++ b/install/pulse-install.sh @@ -0,0 +1,114 @@ +#!/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 + +source /dev/stdin <<<"$FUNCTIONS_FILE_PATH" + +color +verb_ip6 +catch_errors +setting_up_container +network_check +update_os + +APP="Pulse" +APP_DIR="/opt/pulse-proxmox" +PULSE_USER="pulse" +SERVICE_NAME="pulse-monitor.service" + +msg_info "Creating dedicated user pulse..." +if id pulse &>/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" + 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 + +msg_info "Installing Dependencies" +$STD apt-get install -y \ + git \ + jq \ + diffutils +msg_ok "Installed Core Dependencies" + +NODE_VERSION="20" NODE_MODULE="yarn@latest" install_node_and_modules + +msg_info "Setup ${APP}" +$STD git clone https://github.com/rcourtman/Pulse.git /opt/pulse-proxmox +cd /opt/pulse-proxmox +$STD npm install --unsafe-perm +cd /opt/pulse-proxmox/server +$STD npm install --unsafe-perm +cd /opt/pulse-proxmox +$STD npm run build:css +ENV_EXAMPLE="/opt/pulse-proxmox/.env.example" +ENV_FILE="${/opt/pulse-proxmox}/.env" +if [ -f "$ENV_EXAMPLE" ]; then + if [ ! -s "$ENV_FILE" ]; then + cp "$ENV_EXAMPLE" "$ENV_FILE" + msg_info "Created ${ENV_FILE} from example." + 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 + chmod 600 "$ENV_FILE" +else + msg_warning "${ENV_EXAMPLE} not found. Skipping environment configuration." +fi + +msg_info "Setting permissions for /opt/pulse-proxmox..." +chown -R ${PULSE_USER}:${PULSE_USER} "/opt/pulse-proxmox" +find "/opt/pulse-proxmox" -type d -exec chmod 755 {} \; +find "/opt/pulse-proxmox" -type f -exec chmod 644 {} \; +chmod 600 "$ENV_FILE" +msg_ok "Set permissions." + +msg_info "Saving installed version information..." +VERSION_TO_SAVE="${LATEST_RELEASE:-$(git rev-parse --short HEAD)}" +echo "${VERSION_TO_SAVE}" >/opt/${APP}_version.txt +msg_ok "Saved version info (${VERSION_TO_SAVE})." + +msg_info "Creating Service" +cat </etc/systemd/system/pulse-monitor.service +[Unit] +Description=Pulse Monitoring Application +After=network.target + +[Service] +Type=simple +User=pulse +Group=pulse +WorkingDirectory=/opt/pulse-proxmox +EnvironmentFile=/opt/pulse-proxmox/.env +ExecStart=/usr/bin/npm run start +Restart=on-failure +RestartSec=5 +StandardOutput=journal +StandardError=journal + +[Install] +WantedBy=multi-user.target +EOF +systemctl enable -q --now pulse-monitor.service +msg_ok "Created Service" + +motd_ssh +customize + +msg_info "Cleaning up apt cache..." +$STD apt-get -y autoremove +$STD apt-get -y autoclean +msg_ok "Cleaned up." diff --git a/json/pulse.json b/json/pulse.json new file mode 100644 index 0000000..554e6a9 --- /dev/null +++ b/json/pulse.json @@ -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": [] +} \ No newline at end of file