metrics_template/.env.example
2026-03-06 18:41:07 -05:00

65 lines
2.9 KiB
Text

# ==============================================================================
# Metrics Stack — Environment Configuration
# ==============================================================================
# Copy this file to .env and fill in your values before starting the stack.
# cp .env.example .env
# ==============================================================================
# ------------------------------------------------------------------------------
# Client Identity
# Used for your own reference — update to match the client/site.
# ------------------------------------------------------------------------------
CLIENT_NAME=ClientName
# ------------------------------------------------------------------------------
# Host Binding
# The LAN IP of the machine running this stack.
# Services bind to this IP so they are reachable over VPN.
# Use 0.0.0.0 to bind to all interfaces (less secure).
# ------------------------------------------------------------------------------
BIND_HOST=192.168.X.X
# ------------------------------------------------------------------------------
# Timezone
# Used by Grafana for display. Use TZ database names:
# https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
# ------------------------------------------------------------------------------
TZ=America/New_York
# ------------------------------------------------------------------------------
# VictoriaMetrics
# VM_RETENTION_PERIOD: how many months of metrics to keep (default: 6)
# VM_PORT: port VictoriaMetrics listens on (default: 8428)
# ------------------------------------------------------------------------------
VM_RETENTION_PERIOD=6
VM_PORT=8428
# ------------------------------------------------------------------------------
# vmagent
# The scrape agent. Manages all endpoint collection.
# See vmagent/config/scrape.yml to configure endpoints.
# VMAGENT_PORT: port for the vmagent web UI (default: 8429)
# ------------------------------------------------------------------------------
VMAGENT_PORT=8429
# ------------------------------------------------------------------------------
# Grafana
# GF_PORT: port Grafana listens on (default: 3000)
# GF_ADMIN_USER: admin username
# GF_ADMIN_PASSWORD: admin password — CHANGE THIS
# ------------------------------------------------------------------------------
GF_PORT=3000
GF_ADMIN_USER=admin
GF_ADMIN_PASSWORD=CHANGE_ME_STRONG_PASSWORD
# ------------------------------------------------------------------------------
# Uptime Kuma
# KUMA_PORT: port Uptime Kuma listens on (default: 3001)
# UPTIME_KUMA_WS_ORIGIN_CHECK: set to "bypass" if behind a reverse proxy
# KUMA_SCRAPE_USER / KUMA_SCRAPE_PASSWORD: credentials vmagent uses to
# scrape Uptime Kuma's metrics endpoint. Set these after initial Kuma setup.
# ------------------------------------------------------------------------------
KUMA_PORT=3001
UPTIME_KUMA_WS_ORIGIN_CHECK=bypass
KUMA_SCRAPE_USER=admin
KUMA_SCRAPE_PASSWORD=CHANGE_ME_KUMA_PASSWORD