From d90a071d88c56c6c595fcb755639272d24b92314 Mon Sep 17 00:00:00 2001
From: "push-app-to-main[bot]"
 <203845782+push-app-to-main[bot]@users.noreply.github.com>
Date: Mon, 25 Aug 2025 14:20:38 +0200
Subject: [PATCH] healthchecks (#7177)

* 'Add new script'

* add missing source

* Update documentation URL in healthchecks.

* Update source URL in healthchecks-install.sh

* Update healthchecks.json with additional notes

---------

Co-authored-by: push-app-to-main[bot] <203845782+push-app-to-main[bot]@users.noreply.github.com>
Co-authored-by: CanbiZ <47820557+MickLesk@users.noreply.github.com>
---
 ct/headers/healthchecks                |   6 ++
 ct/healthchecks.sh                     |  70 +++++++++++++
 frontend/public/json/healthchecks.json |  44 ++++++++
 install/healthchecks-install.sh        | 136 +++++++++++++++++++++++++
 4 files changed, 256 insertions(+)
 create mode 100644 ct/headers/healthchecks
 create mode 100644 ct/healthchecks.sh
 create mode 100644 frontend/public/json/healthchecks.json
 create mode 100644 install/healthchecks-install.sh

diff --git a/ct/headers/healthchecks b/ct/headers/healthchecks
new file mode 100644
index 0000000000..8f61c87767
--- /dev/null
+++ b/ct/headers/healthchecks
@@ -0,0 +1,6 @@
+    __               ____  __         __              __       
+   / /_  ___  ____ _/ / /_/ /_  _____/ /_  ___  _____/ /_______
+  / __ \/ _ \/ __ `/ / __/ __ \/ ___/ __ \/ _ \/ ___/ //_/ ___/
+ / / / /  __/ /_/ / / /_/ / / / /__/ / / /  __/ /__/ ,< (__  ) 
+/_/ /_/\___/\__,_/_/\__/_/ /_/\___/_/ /_/\___/\___/_/|_/____/  
+                                                               
diff --git a/ct/healthchecks.sh b/ct/healthchecks.sh
new file mode 100644
index 0000000000..2814c41c57
--- /dev/null
+++ b/ct/healthchecks.sh
@@ -0,0 +1,70 @@
+#!/usr/bin/env bash
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: MickLesk (CanbiZ)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://healthchecks.io/
+
+APP="healthchecks"
+var_tags="${var_tags:-monitoring}"
+var_cpu="${var_cpu:-2}"
+var_ram="${var_ram:-2048}"
+var_disk="${var_disk:-5}"
+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/healthchecks ]]; then
+    msg_error "No ${APP} Installation Found!"
+    exit
+  fi
+
+  RELEASE=$(curl -fsSL https://api.github.com/repos/healthchecks/healthchecks/releases/latest | jq '.tag_name' | sed 's/^"v//;s/"$//')
+  if [[ "${RELEASE}" != "$(cat ~/.healthchecks 2>/dev/null)" ]] || [[ ! -f ~/.healthchecks ]]; then
+    msg_info "Stopping $APP"
+    systemctl stop healthchecks
+    msg_ok "Stopped $APP"
+
+    setup_uv
+    fetch_and_deploy_gh_release "healthchecks" "healthchecks/healthchecks"
+
+    msg_info "Updating $APP to v${RELEASE}"
+    cd /opt/healthchecks
+    mkdir -p /opt/healthchecks/static-collected/
+    $STD uv pip install wheel gunicorn -r requirements.txt --system
+    $STD uv run -- python manage.py makemigrations
+    $STD uv run -- python manage.py migrate --noinput
+    $STD uv run -- python manage.py collectstatic --noinput
+    $STD uv run -- python manage.py compress
+    msg_ok "Updated $APP to v${RELEASE}"
+
+    msg_info "Starting $APP"
+    systemctl start healthchecks
+    systemctl restart caddy
+    msg_ok "Started $APP"
+
+    msg_ok "Update Successful"
+  else
+    msg_ok "No update required. ${APP} is already at v${RELEASE}"
+  fi
+  exit
+}
+
+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}https://${IP}${CL}"
diff --git a/frontend/public/json/healthchecks.json b/frontend/public/json/healthchecks.json
new file mode 100644
index 0000000000..75280844ca
--- /dev/null
+++ b/frontend/public/json/healthchecks.json
@@ -0,0 +1,44 @@
+{
+  "name": "Healthchecks",
+  "slug": "healthchecks",
+  "categories": [
+    9
+  ],
+  "date_created": "2025-08-25",
+  "type": "ct",
+  "updateable": true,
+  "privileged": false,
+  "config_path": "/opt/healthchecks/hc/local_settings.py",
+  "interface_port": 3000,
+  "documentation": "https://healthchecks.io/docs/",
+  "website": "https://healthchecks.io/",
+  "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons/webp/healthchecks.webp",
+  "description": "Healthchecks is a cron job monitoring service. It listens for HTTP requests and email messages (\"pings\") from your cron jobs and scheduled tasks (\"checks\"). When a ping does not arrive on time, Healthchecks sends out alerts. Healthchecks comes with a web dashboard, API, 25+ integrations for delivering notifications, monthly email reports, WebAuthn 2FA support, team management features: projects, team members, read-only access.",
+  "install_methods": [
+    {
+      "type": "default",
+      "script": "ct/healthchecks.sh",
+      "resources": {
+        "cpu": 2,
+        "ram": 2048,
+        "hdd": 5,
+        "os": "Debian",
+        "version": "12"
+      }
+    }
+  ],
+  "default_credentials": {
+    "username": null,
+    "password": null
+  },
+  "notes": [
+    {
+      "text": "if you change your LXC-IP, you need to update /etc/caddy/Caddyfile & /opt/healthchecks/hc/local_settings.py",
+      "type": "info"
+    },
+    {
+      "text": "Show credentials: `cat ~/healthchecks.creds`",
+      "type": "info"
+    }
+  ]
+}
diff --git a/install/healthchecks-install.sh b/install/healthchecks-install.sh
new file mode 100644
index 0000000000..ece4604425
--- /dev/null
+++ b/install/healthchecks-install.sh
@@ -0,0 +1,136 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: MickLesk (Canbiz)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://healthchecks.io/
+
+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 \
+  gcc \
+  libpq-dev \
+  libcurl4-openssl-dev \
+  libssl-dev \
+  caddy
+msg_ok "Installed Dependencies"
+
+setup_uv
+PG_VERSION=16 setup_postgresql
+
+msg_info "Setup Database"
+DB_NAME=healthchecks_db
+DB_USER=hc_user
+DB_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | cut -c1-13)
+SECRET_KEY="$(openssl rand -base64 32 | tr -dc 'a-zA-Z0-9' | cut -c1-32)"
+ADMIN_EMAIL="admin@helper-scripts.local"
+ADMIN_PASSWORD="$DB_PASS"
+
+$STD sudo -u postgres psql -c "CREATE ROLE $DB_USER WITH LOGIN PASSWORD '$DB_PASS';"
+$STD sudo -u postgres psql -c "CREATE DATABASE $DB_NAME WITH OWNER $DB_USER ENCODING 'UTF8' TEMPLATE template0;"
+$STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET client_encoding TO 'utf8';"
+$STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET default_transaction_isolation TO 'read committed';"
+$STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET timezone TO 'UTC'"
+{
+  echo "healthchecks-Credentials"
+  echo "healthchecks Database User: $DB_USER"
+  echo "healthchecks Database Password: $DB_PASS"
+  echo "healthchecks Database Name: $DB_NAME"
+  echo "healthchecks Admin Email: $ADMIN_EMAIL"
+  echo "healthchecks Admin Password: $ADMIN_PASSWORD"
+} >>~/healthchecks.creds
+msg_ok "Set up Database"
+
+fetch_and_deploy_gh_release "healthchecks" "healthchecks/healthchecks"
+
+msg_info "Setup healthchecks"
+cd /opt/healthchecks
+mkdir -p /opt/healthchecks/static-collected/
+$STD uv pip install wheel gunicorn -r requirements.txt --system
+
+LOCAL_IP=$(hostname -I | awk '{print $1}')
+cat <<EOF >/opt/healthchecks/hc/local_settings.py
+DEBUG = False
+
+ALLOWED_HOSTS = ["${LOCAL_IP}", "127.0.0.1", "localhost"]
+CSRF_TRUSTED_ORIGINS = ["http://${LOCAL_IP}", "https://${LOCAL_IP}"]
+
+SECRET_KEY = "${SECRET_KEY}"
+
+SITE_ROOT = "http://${LOCAL_IP}:8000"
+SITE_NAME = "MyChecks"
+DEFAULT_FROM_EMAIL = "healthchecks@${LOCAL_IP}"
+
+STATIC_ROOT = "/opt/healthchecks/static-collected"
+COMPRESS_OFFLINE = True
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': '${DB_NAME}',
+        'USER': '${DB_USER}',
+        'PASSWORD': '${DB_PASS}',
+        'HOST': '127.0.0.1',
+        'PORT': '5432',
+        'TEST': {'CHARSET': 'UTF8'}
+    }
+}
+EOF
+
+$STD uv run -- python manage.py makemigrations
+$STD uv run -- python manage.py migrate --noinput
+$STD uv run -- python manage.py collectstatic --noinput
+$STD uv run -- python manage.py compress
+
+cat <<EOF | $STD uv run -- python manage.py shell
+from django.contrib.auth import get_user_model
+User = get_user_model()
+if not User.objects.filter(email="${ADMIN_EMAIL}").exists():
+    User.objects.create_superuser("${ADMIN_EMAIL}", "${ADMIN_EMAIL}", "${ADMIN_PASSWORD}")
+EOF
+msg_ok "Installed healthchecks"
+
+msg_info "Configuring Caddy"
+cat <<EOF >/etc/caddy/Caddyfile
+{
+    email admin@example.com
+}
+
+${LOCAL_IP} {
+    reverse_proxy 127.0.0.1:8000
+}
+EOF
+msg_ok "Configured Caddy"
+
+msg_info "Creating Service"
+cat <<EOF >/etc/systemd/system/healthchecks.service
+[Unit]
+Description=Healthchecks Service
+After=network.target postgresql.service
+
+[Service]
+WorkingDirectory=/opt/healthchecks/
+ExecStart=/usr/local/bin/uv run -- gunicorn hc.wsgi:application --bind 127.0.0.1:8000
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl enable -q --now healthchecks caddy
+systemctl reload caddy
+msg_ok "Created Service"
+
+motd_ssh
+customize
+
+msg_info "Cleaning up"
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"