26e98698d8
Phase 2 and 4 of docs/roadmap/storage-locations.md. Apps can now be placed on a location and moved between them. CFG_<APP>_STORAGE lands in all 37 app templates, holding a location NAME rather than a path: names survive a migrate to a host with different disks, paths do not. The 11 infrastructure apps that other apps reach by literal path (traefik, prometheus, grafana, adguard, gluetun, crowdsec, headscale, dashy, pihole, unbound, wireguard) are pinned. libreportal itself never gets the key — it is pinned structurally by webuiDir. Pinning needed no second config key. "Pinned" is not a fact about a value, it is a statement about whether the field may be edited, so it goes in the comment beside **ADVANCED** and **DEV** as **READONLY**, and the field factory renders those disabled. That marker earns its keep beyond this feature: derived fields already warned in prose that editing them does nothing (crowdsec.config:72) next to a perfectly editable input. storage_app_config.sh keeps the comment honest — it carries the resolved path for hand-recovery and regenerates the dropdown from the registry, but only writes when something actually changed, since the app .config is user-editable and lives in the container-owned tree. app move stops the app (a live copy of a running Postgres is a corrupt copy), snapshots it, copies, verifies, and only then removes the source. The copy runs in libreportal-ownership because it must: app data holds rootless sub-UID files the manager can neither read nor recreate. Verified against two real ext4 filesystems that a cross-device move preserves uid 231141 and the payload, and that the source survives every refusal path — unregistered destination, the WebUI app, a traversal in the app name, and an occupied destination. Task titles registered in both tables, with a specific rule so a move renders as "Nextcloud - Move to bigdisk" rather than the generic fallback dropping the destination. lp-task-names could not be run to confirm — it borrows the WebUI container's node and no containers are running. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
112 lines
6.1 KiB
Plaintext
112 lines
6.1 KiB
Plaintext
#
|
|
# =============================================================================
|
|
# 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_GLUETUN_APP_NAME=gluetun
|
|
# MULTI_INSTANCE = if true, this app can run as multiple isolated instances
|
|
# (own data/DB/subdomain/backups) via `libreportal instance create`. Only set on
|
|
# apps whose compose identity (container_name, Traefik routers, backup labels)
|
|
# is instance-safe — see scripts/instance/instance_create.sh.
|
|
# Not instanced by design. A network provider, not a destination: other apps join it with network_mode "container:gluetun-service". A second copy leaves that name ambiguous.
|
|
CFG_GLUETUN_MULTI_INSTANCE=false
|
|
CFG_GLUETUN_BACKUP=true
|
|
# STORAGE = which storage location holds this app's data.
|
|
CFG_GLUETUN_STORAGE=default # Storage Location - Fixed: other apps reference gluetun by path **READONLY**
|
|
CFG_GLUETUN_BACKUP_STRATEGY=auto
|
|
CFG_GLUETUN_UPDATE_TYPE=auto
|
|
CFG_GLUETUN_COMPOSE_FILE=default
|
|
CFG_GLUETUN_HEALTHCHECK=true
|
|
CFG_GLUETUN_AUTHELIA=false
|
|
CFG_GLUETUN_HEADSCALE=false
|
|
CFG_GLUETUN_MONITORING=false
|
|
#
|
|
# =============================================================================
|
|
# APPLICATION CONFIGURATION
|
|
# =============================================================================
|
|
# VPN_SERVICE_PROVIDER = VPN provider name (mullvad, nordvpn, protonvpn, surfshark, expressvpn, etc.)
|
|
# VPN_TYPE = wireguard or openvpn
|
|
# VPN_COUNTRIES = comma-separated country list (e.g. "Switzerland,Sweden") or empty for any
|
|
# OPENVPN_USER = OpenVPN account username (only when VPN_TYPE=openvpn)
|
|
# OPENVPN_PASSWORD = OpenVPN account password (only when VPN_TYPE=openvpn)
|
|
# WIREGUARD_PRIVATE_KEY = WireGuard private key (only when VPN_TYPE=wireguard)
|
|
# WIREGUARD_ADDRESSES = WireGuard interface address (e.g. "10.64.0.2/32")
|
|
# CONTROL_SERVER_API_KEY = API key for the gluetun HTTP control server, blank to disable auth
|
|
#
|
|
CFG_GLUETUN_VPN_SERVICE_PROVIDER=mullvad
|
|
CFG_GLUETUN_VPN_TYPE=wireguard
|
|
CFG_GLUETUN_VPN_COUNTRIES=
|
|
CFG_GLUETUN_OPENVPN_USER=
|
|
CFG_GLUETUN_OPENVPN_PASSWORD=
|
|
CFG_GLUETUN_WIREGUARD_PRIVATE_KEY=
|
|
CFG_GLUETUN_WIREGUARD_ADDRESSES=
|
|
# HEALTH_TARGETS = comma-separated host:port list pinged over HTTPS to
|
|
# confirm the VPN tunnel is healthy. Defaults are privacy-respecting
|
|
# (Mullvad — your VPN provider; EFF — privacy non-profit). Override
|
|
# with your own targets if you want to check different sites.
|
|
# HEALTH_ICMP_IPS = comma-separated IPv4 list pinged over ICMP for the
|
|
# small recurring health check. Default Quad9 (Swiss non-profit DNS,
|
|
# no logging).
|
|
#
|
|
CFG_GLUETUN_HEALTH_TARGETS="mullvad.net:443,eff.org:443"
|
|
CFG_GLUETUN_HEALTH_ICMP_IPS="9.9.9.9"
|
|
# PROVIDERS_REFRESH_HOURS = how often (hours) to re-fetch gluetun's upstream
|
|
# server list, which powers the provider/country pickers. It's a few MB and
|
|
# rarely changes, so we don't pull it on every WebUI update. Lower it for a
|
|
# fresher list, raise it on a slow/metered link, or set 0 to never auto-fetch
|
|
# (refresh on demand from the Tools tab instead). Default 24.
|
|
#
|
|
CFG_GLUETUN_PROVIDERS_REFRESH_HOURS=24
|
|
#
|
|
# =============================================================================
|
|
# 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_GLUETUN_CATEGORY="networking,recommended"
|
|
CFG_GLUETUN_TITLE="Gluetun"
|
|
CFG_GLUETUN_DESCRIPTION="VPN Container Router"
|
|
CFG_GLUETUN_LONG_DESCRIPTION="Run all of your containers through a VPN provider. 30+ providers over WireGuard and OpenVPN, with a built-in kill-switch and port forwarding"
|
|
CFG_GLUETUN_URL="https://github.com/qdm12/gluetun"
|
|
CFG_GLUETUN_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_GLUETUN_DOMAIN=1
|
|
CFG_GLUETUN_WHITELIST=false
|
|
CFG_GLUETUN_NETWORK=default
|
|
#
|
|
# =============================================================================
|
|
# 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_GLUETUN_PORT_1="gluetun-service|control|random:8000|private|tcp|false|false|false|HTTP Server|"
|
|
CFG_GLUETUN_PORT_2="gluetun-exporter|metrics|8090:8090|disabled|tcp|false|false|false|Metrics Exporter (sidecar, docker-network only)|"
|