# # ============================================================================= # 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 # CFG_PORTAINER_APP_NAME=portainer CFG_PORTAINER_BACKUP=true CFG_PORTAINER_COMPOSE_FILE=default CFG_PORTAINER_HEALTHCHECK=true CFG_PORTAINER_AUTHELIA=false CFG_PORTAINER_HEADSCALE=false # # ============================================================================= # 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_PORTAINER_CATEGORY="Development" CFG_PORTAINER_TITLE="Portainer" CFG_PORTAINER_DESCRIPTION="Docker Management" CFG_PORTAINER_LONG_DESCRIPTION="Portainer is a lightweight management UI for Docker, Docker Swarm, and Kubernetes that allows you to manage your containers easily" CFG_PORTAINER_URL="https://github.com/portainer/portainer" CFG_PORTAINER_ACTIONS="configure|install|restart|shutdown|uninstall" # # ============================================================================= # NETWORK CONFIGURATION # ============================================================================= # DOMAIN = number of domain from the general config, useful when using multiple domains # HOST_NAME = subdomain name e.g test is the name for test.website.com # WHITELIST = if true only allow whitelisted ips on traefik, if false allow all # PUBLIC = if true, app is publicly accessible, if false, only accessible on local network # CFG_PORTAINER_DOMAIN=1 CFG_PORTAINER_WHITELIST=false CFG_PORTAINER_HOST_NAME=portainer CFG_PORTAINER_NETWORK=default CFG_PORTAINER_PUBLIC=true # # ============================================================================= # PORT CONFIGURATION # ============================================================================= # PORT_ = port configuration: app|name|external:internal|access|protocol|login|traefik|webui|description # - app: application name # - name: service identifier (webui, api, 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_PORTAINER_PORT_1="portainer-service|webui|random:9000|public|tcp|false|true|true|Web Interface|" CFG_PORTAINER_PORT_2="portainer-service|agent-edge|random:8000|disabled|tcp|false|false|false|Edge Agent|"