# # ============================================================================= # GENERAL CONFIGURATION # ============================================================================= # APP_NAME = name of application for use in scripts # REQUIRES = comma-separated install prerequisites (see scripts/checks/requirements/check_app_install.sh) # 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_GRAFANA_APP_NAME=grafana CFG_GRAFANA_REQUIRES="prometheus" CFG_GRAFANA_BACKUP=true CFG_GRAFANA_BACKUP_STRATEGY=auto CFG_GRAFANA_COMPOSE_FILE=default CFG_GRAFANA_HEALTHCHECK=true CFG_GRAFANA_AUTHELIA=false CFG_GRAFANA_HEADSCALE=false CFG_GRAFANA_MONITORING=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_GRAFANA_CATEGORY="monitoring" CFG_GRAFANA_TITLE="Grafana" CFG_GRAFANA_DESCRIPTION="Metrics Visualizer" CFG_GRAFANA_LONG_DESCRIPTION="The open source analytics and monitoring solution for every database with beautiful dashboards and alerting capabilities" CFG_GRAFANA_URL="https://github.com/grafana/grafana" CFG_GRAFANA_ACTIONS="configure|install|restart|shutdown|uninstall" CFG_GRAFANA_REQUIRES_SERVICE=prometheus # # ============================================================================= # NETWORK CONFIGURATION # ============================================================================= # DOMAIN = number of domain from the general config, useful when using multiple domains # WHITELIST = if true only allow whitelisted ips (see general config), if false allow all # CFG_GRAFANA_DOMAIN=1 CFG_GRAFANA_WHITELIST=false CFG_GRAFANA_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_GRAFANA_PORT_1="grafana-service|webui|random:3000|public|tcp|false|true|true|Web Interface||grafana"