diff --git a/ct/headers/pulse b/ct/headers/pulse new file mode 100644 index 000000000..3d3b702f1 --- /dev/null +++ b/ct/headers/pulse @@ -0,0 +1,6 @@ + ____ __ + / __ \__ __/ /_______ + / /_/ / / / / / ___/ _ \ + / ____/ /_/ / (__ ) __/ +/_/ \__,_/_/____/\___/ + diff --git a/ct/pulse.sh b/ct/pulse.sh new file mode 100644 index 000000000..580899850 --- /dev/null +++ b/ct/pulse.sh @@ -0,0 +1,79 @@ +#!/usr/bin/env bash +source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func) +# Copyright (c) 2021-2025 community-scripts ORG +# Author: rcourtman +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/rcourtman/Pulse + +APP="Pulse" +var_tags="${var_tags:-monitoring,proxmox}" +var_cpu="${var_cpu:-1}" +var_ram="${var_ram:-1024}" +var_disk="${var_disk:-4}" +var_os="${var_os:-debian}" +var_version="${var_version:-12}" +var_unprivileged="${var_unprivileged:-1}" + +header_info "$APP" +variables +color +catch_errors + +function update_script() { + header_info + check_container_storage + check_container_resources + if [[ ! -d /opt/pulse-proxmox ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + RELEASE=$(curl -fsSL https://api.github.com/repos/rcourtman/Pulse/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }') + if [[ ! -f /opt/${APP}_version.txt ]] || [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]]; then + msg_info "Stopping ${APP}" + systemctl stop pulse-monitor + msg_ok "Stopped ${APP}" + + msg_info "Updating Pulse" + if [[ -f /opt/pulse-proxmox/.env ]]; then + cp /opt/pulse-proxmox/.env /tmp/.env.backup.pulse + fi + temp_file=$(mktemp) + mkdir -p /opt/pulse-proxmox + rm -rf /opt/pulse-proxmox/* + curl -fsSL "https://github.com/rcourtman/Pulse/archive/refs/tags/v${RELEASE}.tar.gz" -o "$temp_file" + tar zxf "$temp_file" --strip-components=1 -C /opt/pulse-proxmox + if [[ -f /tmp/.env.backup.pulse ]]; then + mv /tmp/.env.backup.pulse /opt/pulse-proxmox/.env + fi + 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 + echo "${RELEASE}" >/opt/${APP}_version.txt + msg_ok "Updated Pulse to ${RELEASE}" + + msg_info "Setting permissions for /opt/pulse-proxmox..." + chown -R pulse:pulse "/opt/pulse-proxmox" + find "/opt/pulse-proxmox" -type d -exec chmod 755 {} \; + find "/opt/pulse-proxmox" -type f -exec chmod 644 {} \; + chmod 600 /opt/pulse-proxmox/.env + msg_ok "Set permissions." + + msg_info "Starting ${APP}" + systemctl start pulse-monitor + msg_ok "Started ${APP}" + else + msg_ok "No update required. ${APP} is already at ${RELEASE}." + fi +} + +start +build_container +description + +msg_ok "Completed Successfully!\n" +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}(:your_port)${CL}" diff --git a/frontend/public/json/pulse.json b/frontend/public/json/pulse.json new file mode 100644 index 000000000..09da31d71 --- /dev/null +++ b/frontend/public/json/pulse.json @@ -0,0 +1,40 @@ +{ + "name": "Pulse", + "slug": "pulse", + "categories": [ + 9 + ], + "date_created": "2025-05-22", + "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", + "config_path": "/opt/pulse-proxmox/.env", + "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": [ + { + "text": "Create Proxmox-API-Token first: `https: //github.com/rcourtman/Pulse?tab=readme-ov-file#creating-a-proxmox-api-token`", + "type": "Info" + } + ] +} diff --git a/install/pulse-install.sh b/install/pulse-install.sh new file mode 100644 index 000000000..091af1bd9 --- /dev/null +++ b/install/pulse-install.sh @@ -0,0 +1,100 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2025 community-scripts ORG +# Author: rcourtman +# License: MIT | https://github.com/community-scripts/ProxmoxVE/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 + +msg_info "Installing Dependencies" +$STD apt-get install -y \ + diffutils +msg_ok "Installed Core Dependencies" + +msg_info "Creating dedicated user pulse..." +if useradd -r -m -d /opt/pulse-home -s /bin/bash pulse; then + msg_ok "User created." +else + msg_error "User creation failed." + exit 1 +fi + +NODE_VERSION="20" install_node_and_modules + +msg_info "Setup Pulse" +RELEASE=$(curl -fsSL https://api.github.com/repos/rcourtman/Pulse/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }') +temp_file=$(mktemp) +mkdir -p /opt/pulse-proxmox +curl -fsSL "https://github.com/rcourtman/Pulse/archive/refs/tags/v${RELEASE}.tar.gz" -o "$temp_file" +tar zxf "$temp_file" --strip-components=1 -C /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 +echo "${RELEASE}" >/opt/${APPLICATION}_version.txt +msg_ok "Installed Pulse" + +read -rp "${TAB3}Proxmox Host (z. B. https://proxmox.example.com:8006): " PROXMOX_HOST +read -rp "${TAB3}Proxmox Token ID (z. B. user@pam!mytoken): " PROXMOX_TOKEN_ID +read -rp "${TAB3}Proxmox Token Secret: " PROXMOX_TOKEN_SECRET +read -rp "${TAB3}Port (default: 7655): " PORT +PORT="${PORT:-7655}" + +msg_info "Creating .env file" +cat </opt/pulse-proxmox/.env +PROXMOX_HOST=${PROXMOX_HOST} +PROXMOX_TOKEN_ID=${PROXMOX_TOKEN_ID} +PROXMOX_TOKEN_SECRET=${PROXMOX_TOKEN_SECRET} +PORT=${PORT} +EOF +msg_ok "Created .env file" + +msg_info "Setting permissions for /opt/pulse-proxmox..." +chown -R pulse:pulse "/opt/pulse-proxmox" +find "/opt/pulse-proxmox" -type d -exec chmod 755 {} \; +find "/opt/pulse-proxmox" -type f -exec chmod 644 {} \; +chmod 600 /opt/pulse-proxmox/.env +msg_ok "Set permissions." + +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 +msg_ok "Created Service" + +motd_ssh +customize + +msg_info "Cleaning up" +rm -f "$temp_file" +$STD apt-get -y autoremove +$STD apt-get -y autoclean +msg_ok "Cleaned"