lerko
b32145fb58
Documentation: - Fix CI badge href to /actions (was 404 on Gitea) - Add UPTOP_METRICS_PUBLIC + UPTOP_MAINT_RETENTION to README env table - Link maintenance retention to env var name in data retention section - Note metrics auth requirement in features list - Fix clustering.md: fail-closed wording, mark AGG_STRATEGY/NODE_REGION optional - Fix .env.example: wording (no .env loader), add TRUSTED_PROXIES + MAINT_RETENTION - Add CLI help/usage with subcommand listing, accept serve/help/-h/-version Docker/deploy: - Add EXPOSE 8080 to Dockerfile - Remove dead LIPGLOSS_RENDERER_HAS_DARK_BACKGROUND env - Exempt /api/health from cluster auth (fixes Docker HEALTHCHECK 401) - Add sysctls for unprivileged ping to all compose files Cosmetic: - Fix bug_report.yaml: SemVer placeholder, remove nonexistent serve subcommand
45 lines
3.5 KiB
Bash
45 lines
3.5 KiB
Bash
# ─── uptop configuration ───────────────────────────────────
|
|
# Export in your environment or pass via docker run --env-file.\n# Only uncomment what you need.
|
|
|
|
# ─── Core ──────────────────────────────────────────────────
|
|
UPTOP_PORT=23234 # SSH server port
|
|
UPTOP_HTTP_PORT=8080 # HTTP port (status page, push endpoints, metrics)
|
|
UPTOP_DB_TYPE=sqlite # sqlite or postgres
|
|
UPTOP_DB_DSN=/data/uptop.db # File path (SQLite) or connection string (Postgres)
|
|
|
|
# ─── Security ─────────────────────────────────────────────
|
|
# UPTOP_ADMIN_KEY=ssh-ed25519 AAAA... you@host # Seed first admin user on startup
|
|
# UPTOP_KEYS=/data/authorized_keys # Path to authorized_keys file (one key per line)
|
|
# UPTOP_SSH_HOST_KEY=/data/.ssh/id_ed25519 # SSH host key path (auto-generated if missing)
|
|
# UPTOP_ENCRYPTION_KEY= # AES-256-GCM key for alert credentials (64 hex chars)
|
|
# # Generate: openssl rand -hex 32
|
|
# # Without this, alert passwords/tokens stored in plaintext
|
|
# UPTOP_CLUSTER_SECRET= # Shared key for cluster API + import/export auth
|
|
|
|
# ─── Status Page ──────────────────────────────────────────
|
|
# UPTOP_STATUS_ENABLED=false # Enable public status page at /status
|
|
# UPTOP_STATUS_TITLE=System Status # Status page heading
|
|
|
|
# ─── TLS ──────────────────────────────────────────────────
|
|
# UPTOP_TLS_CERT= # Path to TLS certificate (enables HTTPS)
|
|
# UPTOP_TLS_KEY= # Path to TLS private key
|
|
|
|
# ─── Clustering (leader/follower) ────────────────────────
|
|
# See docs/clustering.md for setup guides.
|
|
# UPTOP_CLUSTER_MODE=leader # leader, follower, or probe
|
|
# UPTOP_PEER_URL= # Leader HTTP URL (required for follower and probe)
|
|
|
|
# ─── Distributed Probing ─────────────────────────────────
|
|
# UPTOP_NODE_ID= # Unique node identifier (required for probe mode)
|
|
# UPTOP_NODE_NAME= # Human-readable node name
|
|
# UPTOP_NODE_REGION= # Region tag (e.g. us-east, eu-west) for monitor routing
|
|
# UPTOP_AGG_STRATEGY=any-down # How multi-probe results combine: any-down, majority-down, all-down
|
|
|
|
# ─── Advanced ─────────────────────────────────────────────
|
|
# UPTOP_INSECURE_SKIP_VERIFY=false # Skip TLS cert verification on monitored targets
|
|
# UPTOP_ALLOW_PRIVATE_TARGETS=false # Allow monitoring RFC1918/loopback addresses
|
|
# UPTOP_METRICS_PUBLIC=false # Expose /metrics without auth
|
|
# UPTOP_CORS_ORIGIN= # Access-Control-Allow-Origin for /status/json
|
|
# UPTOP_TRUSTED_PROXIES= # Comma-separated CIDRs/IPs for X-Forwarded-For trust
|
|
# UPTOP_MAINT_RETENTION=168h # How long ended maintenance windows are kept
|