mirror of
https://github.com/community-scripts/ProxmoxVE.git
synced 2026-03-03 16:15:54 +00:00
* Standardize exit codes and add mappings Replace generic exit 1 usages with specific numeric exit codes and add corresponding explanations to the error lookup. This commit updates multiple misc/* scripts to return distinct codes for validation, Proxmox/LXC, networking, download and curl errors (e.g. 103-123, 64, 107-120, 206, 0 for explicit user cancels). It also updates curl error handling to propagate the original curl exit code and adds new entries in explain_exit_code and the error handler to improve diagnostics. * Set exit code 115 for update_os errors Change exit status from 6 to 115 in misc/alpine-install.func's update_os() error handlers when failing to download tools.func or when the expected functions are missing. This gives a distinct exit code for these specific failure cases. * Add tools/addon exit codes and use them Introduce exit codes 232-238 for Tools & Addon scripts in misc/api.func and misc/error_handler.func. Update addon scripts (tools/addon/adguardhome-sync.sh, tools/addon/copyparty.sh, tools/addon/cronmaster.sh) to return specific codes instead of generic exit 1: 238 for unsupported OS and 233 when the application is not installed/upgrade prerequisites are missing. This makes failures more descriptive and aligns scripts with the central error explanations. * Standardize exit codes in exporter addons Unify exit codes across exporter addon scripts: return 238 for unsupported OS detections and 233 when an update is requested but the exporter is not installed. Applied to nextcloud-exporter.sh, pihole-exporter.sh, prometheus-paperless-ngx-exporter.sh, and qbittorrent-exporter.sh to make failure modes distinguishable for callers/automation. * Use specific exit codes in addon scripts Replace generic exit 1 with distinct exit codes across multiple addon scripts to enable finer-grained error handling in automation. Exit codes introduced: 10 for Docker/Compose missing or user-declined Docker install, 233 for "nothing to update" cases, and 238 for unsupported OS cases. Affected files: tools/addon/arcane.sh, coolify.sh, dockge.sh, dokploy.sh, filebrowser-quantum.sh, filebrowser.sh, immich-public-proxy.sh, jellystat.sh, runtipi.sh. * Use specific exit codes in addon scripts Replace generic exit 1 with specific exit codes across multiple addon scripts to improve error signaling and handling. Files updated: tools/addon/add-netbird-lxc.sh (exit 238 on unsupported distro), tools/addon/add-tailscale-lxc.sh (treat user cancel as exit 0), tools/addon/glances.sh (exit 233 when not installed), tools/addon/komodo.sh (distinct exits for missing compose, legacy DB, backup/download failures, docker checks), tools/addon/netdata.sh (distinct exits for unsupported PVE versions, OS/codename detection, repo lookups), and tools/addon/phpmyadmin.sh (distinct exits for unsupported OS, network/download issues, package install/start failures, and invalid input). These changes make failures easier to identify and automate recovery or reporting. * Use specific exit codes in PVE scripts Replace generic exit 1 with distinct exit codes across tools/pve scripts to provide clearer failure signals for callers. post-pve-install.sh now returns 105 for unsupported Proxmox versions; pve-privilege-converter.sh uses 104 for non-root, 234 when no containers, and 235 for backup/conversion failures; update-apps.sh maps backup failures to 235, missing containers/selections to 234 (and UI cancellations to 0), missing backup storage to 119, and returns the actual container update exit code on failure. These changes improve diagnostics and allow external tooling to react to specific error conditions. * Standardize exit codes and behaviors Adjust exit codes and abort handling across multiple PVE helper scripts to provide clearer outcomes for automation and interactive flows. Changes include: - container-restore-from-backup.sh, core-restore-from-backup.sh: return 235 when no backups found (was 1). - fstrim.sh: treat user cancellation of non-ext4 warning as non-error (exit 0 instead of 1). - kernel-clean.sh: treat no selection or user abort as non-error (exit 0 instead of 1). - lxc-delete.sh: return 234 when no containers are present; treat no selection as non-error (exit 0). - nic-offloading-fix.sh: use specific non-zero codes for root check and tool install failures (exit 104, 237) and 236 when no matching interfaces (was 1). - pbs_microcode.sh, post-pmg-install.sh, post-pbs-install.sh: use distinct exit codes (232 and 105) for detected VM/PVE/unsupported distro conditions instead of generic 1. These modifications make scripts return distinct codes for different failure modes and ensure user-initiated aborts or benign conditions exit with 0 where appropriate. * Use exit 105 for unsupported PVE versions Standardize error handling by replacing generic exit 1 with exit 105 in pve_check() across multiple VM template scripts to indicate unsupported Proxmox VE versions. Also add API exit code 226 message for "Proxmox: VM disk import or post-creation setup failed" in misc/api.func. Affected files include misc/api.func and various vm/*-vm.sh scripts. * Use specific exit codes in VM scripts Replace generic exit 1 with distinct exit codes across vm/*.sh to make failures more actionable for callers. Changes include: use 226 for missing imported-disk references, 237 for pv installation failures, 115 for download/extract/ISO-related failures, 214 for insufficient disk space during FreeBSD decompression, and 119 for missing storage detection. Updated scripts: archlinux-vm.sh, docker-vm.sh, haos-vm.sh, openwrt-vm.sh, opnsense-vm.sh, truenas-vm.sh, umbrel-os-vm.sh.
215 lines
6.6 KiB
Bash
215 lines
6.6 KiB
Bash
#!/usr/bin/env bash
|
|
|
|
# Copyright (c) 2021-2026 community-scripts ORG
|
|
# Author: MickLesk (CanbiZ)
|
|
# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
|
|
# Source: https://dokploy.com/ | Github: https://github.com/Dokploy/dokploy
|
|
if ! command -v curl &>/dev/null; then
|
|
printf "\r\e[2K%b" '\033[93m Setup Source \033[m' >&2
|
|
if [[ -f /etc/alpine-release ]]; then
|
|
apk update >/dev/null 2>&1
|
|
apk add --no-cache curl >/dev/null 2>&1
|
|
else
|
|
apt-get update >/dev/null 2>&1
|
|
apt-get install -y curl >/dev/null 2>&1
|
|
fi
|
|
fi
|
|
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/core.func)
|
|
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/tools.func)
|
|
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/error_handler.func)
|
|
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/api.func) 2>/dev/null || true
|
|
|
|
# Enable error handling
|
|
set -Eeuo pipefail
|
|
trap 'error_handler' ERR
|
|
|
|
# ==============================================================================
|
|
# CONFIGURATION
|
|
# ==============================================================================
|
|
APP="Dokploy"
|
|
APP_TYPE="addon"
|
|
INSTALL_PATH="/etc/dokploy"
|
|
DEFAULT_PORT=3000
|
|
|
|
# Initialize all core functions (colors, formatting, icons, STD mode)
|
|
load_functions
|
|
|
|
# ==============================================================================
|
|
# UNINSTALL
|
|
# ==============================================================================
|
|
function uninstall() {
|
|
msg_info "Uninstalling ${APP}"
|
|
|
|
if command -v docker &>/dev/null; then
|
|
msg_info "Stopping and removing Docker containers"
|
|
$STD docker stop $(docker ps -aq) 2>/dev/null || true
|
|
$STD docker rm $(docker ps -aq) 2>/dev/null || true
|
|
$STD docker network prune -f 2>/dev/null || true
|
|
msg_ok "Stopped and removed Docker containers"
|
|
fi
|
|
|
|
rm -rf "$INSTALL_PATH"
|
|
msg_ok "${APP} has been uninstalled"
|
|
}
|
|
|
|
# ==============================================================================
|
|
# UPDATE
|
|
# ==============================================================================
|
|
function update() {
|
|
msg_info "Updating ${APP}"
|
|
$STD curl -sSL https://dokploy.com/install.sh | bash -s update
|
|
msg_ok "Updated ${APP}"
|
|
|
|
msg_ok "Updated successfully"
|
|
exit
|
|
}
|
|
|
|
# ==============================================================================
|
|
# PROXMOX HOST CHECK
|
|
# ==============================================================================
|
|
function check_proxmox_host() {
|
|
if command -v pveversion &>/dev/null; then
|
|
msg_error "Running on the Proxmox host is NOT recommended!"
|
|
msg_error "This should be executed inside an LXC container."
|
|
echo ""
|
|
echo -n "${TAB}Continue anyway? (y/N): "
|
|
read -r confirm
|
|
if [[ ! "${confirm,,}" =~ ^(y|yes)$ ]]; then
|
|
msg_warn "Aborted. Please run this inside an LXC container."
|
|
exit 0
|
|
fi
|
|
msg_warn "Proceeding on Proxmox host at your own risk!"
|
|
fi
|
|
}
|
|
|
|
# ==============================================================================
|
|
# CHECK / INSTALL DOCKER
|
|
# ==============================================================================
|
|
function check_or_install_docker() {
|
|
if command -v docker &>/dev/null; then
|
|
msg_ok "Docker $(docker --version | cut -d' ' -f3 | tr -d ',') is available"
|
|
if docker compose version &>/dev/null; then
|
|
msg_ok "Docker Compose is available"
|
|
else
|
|
msg_error "Docker Compose plugin is not available. Please install it."
|
|
exit 10
|
|
fi
|
|
return
|
|
fi
|
|
|
|
msg_warn "Docker is not installed."
|
|
echo -n "${TAB}Install Docker now? (y/N): "
|
|
read -r install_docker_prompt
|
|
if [[ ! "${install_docker_prompt,,}" =~ ^(y|yes)$ ]]; then
|
|
msg_error "Docker is required for ${APP}. Exiting."
|
|
exit 10
|
|
fi
|
|
|
|
msg_info "Installing Docker"
|
|
if [[ -f /etc/alpine-release ]]; then
|
|
$STD apk add docker docker-cli-compose
|
|
$STD rc-service docker start
|
|
$STD rc-update add docker default
|
|
else
|
|
DOCKER_CONFIG_PATH='/etc/docker/daemon.json'
|
|
mkdir -p "$(dirname "$DOCKER_CONFIG_PATH")"
|
|
echo -e '{\n "log-driver": "journald"\n}' >"$DOCKER_CONFIG_PATH"
|
|
$STD sh <(curl -fsSL https://get.docker.com)
|
|
fi
|
|
msg_ok "Installed Docker"
|
|
}
|
|
|
|
# ==============================================================================
|
|
# INSTALL
|
|
# ==============================================================================
|
|
function install() {
|
|
check_or_install_docker
|
|
|
|
msg_info "Installing dependencies"
|
|
if [[ -f /etc/alpine-release ]]; then
|
|
$STD apk add --no-cache git openssl
|
|
else
|
|
$STD apt-get update
|
|
$STD apt-get install -y git openssl redis
|
|
fi
|
|
msg_ok "Installed dependencies"
|
|
|
|
msg_warn "WARNING: This will run an external installer from https://dokploy.com/"
|
|
msg_warn "The following code is NOT maintained or audited by our repository."
|
|
echo ""
|
|
echo -n "${TAB}Do you want to continue? (y/N): "
|
|
read -r confirm
|
|
if [[ ! "${confirm,,}" =~ ^(y|yes)$ ]]; then
|
|
msg_warn "Installation cancelled. Exiting."
|
|
exit 0
|
|
fi
|
|
|
|
msg_info "Installing ${APP} (this installs Docker and pulls containers)"
|
|
$STD bash <(curl -sSL https://dokploy.com/install.sh)
|
|
msg_ok "Installed ${APP}"
|
|
|
|
echo ""
|
|
msg_ok "${APP} is reachable at: ${BL}http://${LOCAL_IP}:${DEFAULT_PORT}${CL}"
|
|
}
|
|
|
|
# ==============================================================================
|
|
# MAIN
|
|
# ==============================================================================
|
|
|
|
# Handle type=update (called from update script)
|
|
if [[ "${type:-}" == "update" ]]; then
|
|
header_info
|
|
if [[ -d "$INSTALL_PATH" ]]; then
|
|
update
|
|
else
|
|
msg_error "${APP} is not installed. Nothing to update."
|
|
exit 233
|
|
fi
|
|
exit 0
|
|
fi
|
|
|
|
header_info
|
|
check_proxmox_host
|
|
get_lxc_ip
|
|
|
|
# Check if already installed
|
|
if [[ -d "$INSTALL_PATH" ]]; then
|
|
msg_warn "${APP} is already installed."
|
|
echo ""
|
|
|
|
echo -n "${TAB}Uninstall ${APP}? (y/N): "
|
|
read -r uninstall_prompt
|
|
if [[ "${uninstall_prompt,,}" =~ ^(y|yes)$ ]]; then
|
|
uninstall
|
|
exit 0
|
|
fi
|
|
|
|
echo -n "${TAB}Update ${APP}? (y/N): "
|
|
read -r update_prompt
|
|
if [[ "${update_prompt,,}" =~ ^(y|yes)$ ]]; then
|
|
update
|
|
exit 0
|
|
fi
|
|
|
|
msg_warn "No action selected. Exiting."
|
|
exit 0
|
|
fi
|
|
|
|
# Fresh installation
|
|
msg_warn "${APP} is not installed."
|
|
echo ""
|
|
echo -e "${TAB}${INFO} This will install:"
|
|
echo -e "${TAB} - Dokploy (via external installer)"
|
|
echo -e "${TAB} - Docker (if not already installed)"
|
|
echo -e "${TAB} - Redis"
|
|
echo ""
|
|
|
|
echo -n "${TAB}Install ${APP}? (y/N): "
|
|
read -r install_prompt
|
|
if [[ "${install_prompt,,}" =~ ^(y|yes)$ ]]; then
|
|
install
|
|
else
|
|
msg_warn "Installation cancelled. Exiting."
|
|
exit 0
|
|
fi
|