# # ============================================================================= # GENERAL CONFIGURATION # ============================================================================= # APP_NAME = name of application for use in scripts # COMPOSE_FILE = default for no app_name in docker-compose file name, app if there is # BACKUP = if true, include this application in backup operations # HEALTHCHECK = if true, default docker health checks for that container will be enabled # AUTHELIA = if true, use Authelia authentication, if false turned off. # HEADSCALE = options : false, local, remote (see general config). e.g false or local,remote # MONITORING = if true, export this app's metrics to Prometheus + Grafana (needs both apps installed) # CFG_PIHOLE_APP_NAME=pihole CFG_PIHOLE_BACKUP=true CFG_PIHOLE_BACKUP_STRATEGY=auto CFG_PIHOLE_COMPOSE_FILE=default CFG_PIHOLE_HEALTHCHECK=true CFG_PIHOLE_AUTHELIA=false CFG_PIHOLE_HEADSCALE=false CFG_PIHOLE_MONITORING=false # # ============================================================================= # APPLICATION CONFIGURATION # ============================================================================= # ADMIN_PASSWORD = web interface admin password (will be generated if set to RANDOMIZEDPASSWORD) # WEB_THEME = web interface theme (default-dark, default-light, or custom themes) # CFG_PIHOLE_ADMIN_PASSWORD=RANDOMIZEDPASSWORD1 CFG_PIHOLE_WEB_THEME=default-dark # # ============================================================================= # METADATA # ============================================================================= # CATEGORY = application category for grouping # TITLE = display name for the application # DESCRIPTION = short description of the application # LONG_DESCRIPTION = detailed description of the application # URL = source repository or documentation URL # ACTIONS = available actions for this application # CFG_PIHOLE_CATEGORY="networking" CFG_PIHOLE_TITLE="PiHole" CFG_PIHOLE_DESCRIPTION="DNS-based Ad Blocking" CFG_PIHOLE_LONG_DESCRIPTION="Pi-hole is a DNS sinkhole that protects your devices from unwanted content without installing any client-side software" CFG_PIHOLE_URL="https://github.com/pi-hole/pi-hole" CFG_PIHOLE_ACTIONS="configure|install|restart|shutdown|uninstall" # # ============================================================================= # NETWORK CONFIGURATION # ============================================================================= # DOMAIN = number of domain from the general config, useful when using multiple domains # WHITELIST = if true only allow whitelisted ips on traefik, if false allow all # CFG_PIHOLE_DOMAIN=1 CFG_PIHOLE_WHITELIST=false CFG_PIHOLE_NETWORK=default # # ============================================================================= # PORT CONFIGURATION # ============================================================================= # PORT_ = port configuration: app|name|external:internal|access|protocol|login|traefik|webui|description # - app: application name # - name: service identifier (webui, dns, ssh, etc.) # - external:internal: port mapping (external can be 'random' for auto-allocation) # - access: 'public' (internet accessible), 'private' (local network only), 'disabled' (not running) # - protocol: 'tcp' or 'udp' # - login: if true, this port requires basic-auth via Traefik (only meaningful when traefik=true) # - traefik: if true, Traefik handles this port (reverse proxy) # - webui: if true, this port serves the main web interface # - description: human-readable description of the service # CFG_PIHOLE_PORT_1="pihole-service|webui|random:80|private|tcp|false|false|true|Admin Interface|/admin/|pihole" CFG_PIHOLE_PORT_2="pihole-service|dns-tcp|53:53|private|tcp|false|false|false|DNS Server (TCP)|" CFG_PIHOLE_PORT_3="pihole-service|dns-udp|53:53|private|udp|false|false|false|DNS Server (UDP)|" CFG_PIHOLE_PORT_4="pihole-service|https|random:443|disabled|tcp|false|false|false|HTTPS Interface|" CFG_PIHOLE_PORT_5="pihole-service|unbound|random:5335|private|tcp|false|false|false|Unbound DNS Access|" CFG_PIHOLE_PORT_6="pihole-exporter|metrics|9617:9617|disabled|tcp|false|false|false|Metrics Exporter (sidecar, docker-network only)|"