# # ============================================================================= # 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 # UPDATE_TYPE = auto: new image builds are applied automatically (a recovery snapshot is taken first), manual: only when you press Update # 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_MATTERMOST_APP_NAME=mattermost CFG_MATTERMOST_BACKUP=true CFG_MATTERMOST_BACKUP_STRATEGY=auto CFG_MATTERMOST_UPDATE_TYPE=auto CFG_MATTERMOST_COMPOSE_FILE=default CFG_MATTERMOST_HEALTHCHECK=true # Left false deliberately. Mattermost ships its own account system and its # native desktop/mobile clients authenticate against it directly — putting # Authelia's forward-auth in front of the web port would lock those clients out # of the API without giving single sign-on in return (OIDC/SAML is a paid tier # in the Team Edition shipped here). Turn it on only if you intend to use the # web client exclusively. CFG_MATTERMOST_AUTHELIA=false CFG_MATTERMOST_HEADSCALE=false CFG_MATTERMOST_MONITORING=false # Postgres password for the `mattermost` role, fed to the compose via # #LIBREPORTAL|MATTERMOST_DB_PASSWORD_TAG| (both the server's datasource URL and # the database's own env). Generated on first install and preserved across # reinstalls — initdb sets it once when the volume is created. CFG_MATTERMOST_DB_PASSWORD=RANDOMIZEDPASSWORD1 # # ============================================================================= # 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_MATTERMOST_CATEGORY="communication" CFG_MATTERMOST_TITLE="Mattermost" CFG_MATTERMOST_DESCRIPTION="Team Chat" CFG_MATTERMOST_LONG_DESCRIPTION="Mattermost is a self-hosted team chat platform with channels, threads, file sharing and search, plus polished desktop and mobile clients. The Team Edition here is free and unlimited on users, and runs as one container against Postgres — the low-friction option if you want a Discord or Slack replacement that works the moment it starts" CFG_MATTERMOST_URL="https://github.com/mattermost/mattermost" CFG_MATTERMOST_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 (see general config), if false allow all # CFG_MATTERMOST_DOMAIN=1 CFG_MATTERMOST_WHITELIST=false CFG_MATTERMOST_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_MATTERMOST_PORT_1="mattermost-service|webui|random:8065|public|tcp|false|true|true|Web Interface||mattermost"