Adding comprehensive comments

This commit is contained in:
2025-07-14 12:48:15 +05:30
parent e57dfa763e
commit ff5ae47bef
22 changed files with 683 additions and 329 deletions

View File

@@ -1,39 +1,61 @@
# Healthchecks.io Monitoring Service Configuration
services:
healthchecks:
# Basic container configuration
container_name: healthchecks
image: ghcr.io/linuxserver/healthchecks:3.10.20250705
restart: unless-stopped
# User and system configuration
environment:
- PUID=${PUID}
- PGID=${PGID}
- TZ=${TZ}
- SITE_ROOT=${SITE_ROOT}
- SITE_NAME=${SITE_NAME}
- DEFAULT_FROM_EMAIL=${DEFAULT_FROM_EMAIL}
- EMAIL_HOST=${EMAIL_HOST}
- EMAIL_PORT=${EMAIL_PORT}
- EMAIL_HOST_USER=${EMAIL_HOST_USER}
- EMAIL_HOST_PASSWORD=${EMAIL_HOST_PASSWORD}
- EMAIL_USE_TLS=${EMAIL_USE_TLS}
- EMAIL_USE_SSL=${EMAIL_USE_SSL}
- SUPERUSER_EMAIL=${SUPERUSER_EMAIL}
- SUPERUSER_PASSWORD=${SUPERUSER_PASSWORD}
- SECRET_KEY=${SECRET_KEY}
- APPRISE_ENABLED=${APPRISE_ENABLED}
- REGISTRATION_OPEN=${REGISTRATION_OPEN}
- DEBUG=${DEBUG}
- SITE_LOGO_URL=${SITE_LOGO_URL}
- PING_EMAIL_DOMAIN=${PING_EMAIL_DOMAIN}
- DISCORD_CLIENT_ID=${DISCORD_CLIENT_ID}
- DISCORD_CLIENT_SECRET=${DISCORD_CLIENT_SECRET}
# System settings
- PUID=${PUID} # User ID
- PGID=${PGID} # Group ID
- TZ=${TZ} # Timezone
# Site configuration
- SITE_ROOT=${SITE_ROOT} # Base URL
- SITE_NAME=${SITE_NAME} # Site display name
- SITE_LOGO_URL=${SITE_LOGO_URL} # Custom logo URL
# Email server configuration
- DEFAULT_FROM_EMAIL=${DEFAULT_FROM_EMAIL} # Sender address
- EMAIL_HOST=${EMAIL_HOST} # SMTP server
- EMAIL_PORT=${EMAIL_PORT} # SMTP port
- EMAIL_HOST_USER=${EMAIL_HOST_USER} # SMTP username
- EMAIL_HOST_PASSWORD=${EMAIL_HOST_PASSWORD} # SMTP password
- EMAIL_USE_TLS=${EMAIL_USE_TLS} # Enable TLS
- EMAIL_USE_SSL=${EMAIL_USE_SSL} # Enable SSL
- PING_EMAIL_DOMAIN=${PING_EMAIL_DOMAIN} # Email domain for pings
# Authentication and security
- SUPERUSER_EMAIL=${SUPERUSER_EMAIL} # Admin email
- SUPERUSER_PASSWORD=${SUPERUSER_PASSWORD} # Admin password
- SECRET_KEY=${SECRET_KEY} # Cryptographic secret
- REGISTRATION_OPEN=${REGISTRATION_OPEN} # Allow new registrations
# Integration settings
- APPRISE_ENABLED=${APPRISE_ENABLED} # Enable Apprise notifications
- DISCORD_CLIENT_ID=${DISCORD_CLIENT_ID} # Discord integration
- DISCORD_CLIENT_SECRET=${DISCORD_CLIENT_SECRET} # Discord secret
# Debugging
- DEBUG=${DEBUG} # Debug mode
# Persistent storage configuration
volumes:
- ${APPDATA_PATH}/healthchecks/config:/config
- ${APPDATA_PATH}/healthchecks/config:/config # Configuration storage
# Network port configuration
ports:
- ${PORT}:8000
- ${SMTP_PORT}:2525
- ${PORT}:8000 # Web interface port
- ${SMTP_PORT}:2525 # SMTP port for email
# Network configuration
networks:
- frontend
- frontend # Connects to frontend network
# External network configuration
networks:
frontend:
external: true
external: true # Uses pre-existing frontend network