Ferrule dry-run-5fd0b27

stack.env.example

@@ -0,0 +1,131 @@
+# Once the dashboard is up, Settings -> Stack environment writes every
+# variable, this file's and the rest, from what the stack is running with.
+
+# Required: the release to run, such as 0.9.0, or qa for the build under test.
+FERRULE_VERSION=dry-run-5fd0b27
+
+# false watches only hypervisors and storage, with no UniFi console at all,
+# and is what to set while trying this stack beside an existing one.
+UNIFI_ENABLED=true
+UNIFI_HOST=https://192.168.1.1
+UNIFI_API_KEY=
+UNIFI_USERNAME=
+UNIFI_PASSWORD=
+
+# Protect runs on separate hardware (a UNVR). It is its own UniFi OS console
+# with its own API key and its own local admin — the gateway's credentials
+# will not authenticate against it. Leave these blank if one console runs
+# both Network and Protect.
+PROTECT_HOST=https://192.168.1.4
+PROTECT_API_KEY=
+PROTECT_USERNAME=
+PROTECT_PASSWORD=
+
+UNIFI_SITE=default
+UNIFI_OS=true
+UNIFI_VERIFY_TLS=false
+POLL_INTERVAL=30s
+PROTECT_ENABLED=true
+PROTECT_BOOTSTRAP=true
+WEB_PORT=8090
+RETENTION=13w
+
+# ---- WAN health and ISP accountability -------------------------------
+WAN_ENABLED=true
+WAN_POLL_INTERVAL=60s
+WAN_DASHBOARD_SCALE=24h
+SPEEDTEST_INTERVAL=15m
+BACKFILL_ON_START=true
+LEDGER_RETENTION=8760h
+
+# Demarcation probe. Leave PROBE_TARGETS blank to disable it. The
+# wan_next_hop address must be your ISP first router on the WAN1 subnet,
+# written literally: it stays reachable through a failover because it is
+# directly connected, which a default route would not be.
+#
+# Do not use 192.168.100.1 here. It is both the DOCSIS modem management
+# convention and the Starlink dish address, so what it reaches depends on
+# your network. Modem state comes from the controller instead.
+PROBE_TARGETS=
+PROBE_INTERVAL=60s
+PROBE_COUNT=10
+PROBE_TIMEOUT=2s
+
+# ---- License -------------------------------------------------------------
+# Empty runs a 30-day trial of the paid features, then Community.
+FERRULE_LICENSE=
+
+# ---- Notifications ------------------------------------------------------
+# Each channel is off until its variables are set. Settings -> Notifications
+# shows them all; PORTAINER.md says what each one is.
+GOTIFY_URL=
+GOTIFY_TOKEN=
+NTFY_URL=
+NTFY_TOKEN=
+PUSHOVER_TOKEN=
+PUSHOVER_USER=
+DISCORD_WEBHOOK_URL=
+SMTP_HOST=
+SMTP_PORT=587
+SMTP_TLS=
+SMTP_USERNAME=
+SMTP_PASSWORD=
+SMTP_FROM=
+SMTP_TO=
+# Paid: send during the trial or with a license.
+SLACK_WEBHOOK_URL=
+TEAMS_WEBHOOK_URL=
+PAGERDUTY_ROUTING_KEY=
+WEBHOOK_URL=
+WEBHOOK_SECRET=
+APPRISE_URL=
+APPRISE_URLS=
+APPRISE_KEY=
+DASHBOARD_URL=
+
+# ---- Backups -------------------------------------------------------------
+# A share needs an overlay: docker-compose.backup-nfs.yml or -smb.yml under
+# the stack's Additional paths. S3 is paid. See PORTAINER.md.
+BACKUP_NAME=ferrule
+BACKUP_KEY=
+BACKUP_AT=03:30
+BACKUP_HISTORY=true
+BACKUP_HISTORY_DAY=sunday
+BACKUP_KEEP=14
+BACKUP_HISTORY_KEEP=4
+BACKUP_RESTORE=auto
+# NFS overlay
+BACKUP_NFS_SERVER=
+BACKUP_NFS_PATH=
+# SMB overlay
+BACKUP_SMB_SERVER=
+BACKUP_SMB_SHARE=
+BACKUP_SMB_USERNAME=
+BACKUP_SMB_PASSWORD=
+# S3-compatible storage (paid)
+BACKUP_S3_ENDPOINT=
+BACKUP_S3_REGION=us-east-1
+BACKUP_S3_BUCKET=
+BACKUP_S3_PREFIX=ferrule
+BACKUP_S3_ACCESS_KEY=
+BACKUP_S3_SECRET_KEY=
+
+# ---- Inventory ---------------------------------------------------------
+# Days of history: 365 by default, 2557 for seven years. The database copy
+# is paid: add postgres to COMPOSE_PROFILES and set INVENTORY_DB_PASSWORD
+# for the stack's own, or INVENTORY_DB_URL for yours. See PORTAINER.md.
+INVENTORY_KEEP=365
+INVENTORY_DB_URL=
+INVENTORY_DB_PASSWORD=
+INVENTORY_DB_READER_PASSWORD=
+INVENTORY_DB_BIND=127.0.0.1
+INVENTORY_DB_PORT=5432
+
+# ---- Hypervisors and storage ------------------------------------------
+# One system per slot: kind, address, then optional name=, user=, every=,
+# tls=verify. The credential goes in the matching _SECRET. Kinds: proxmox,
+# pbs, vmware, synology, qnap, truenas. Settings -> Add a source writes these.
+SOURCE_1=
+SOURCE_1_SECRET=
+SOURCE_2=
+SOURCE_2_SECRET=