Pulse/.env.example
rcourtman 8a99b16d6c docs: correct customer docs that drifted from the source
Audited the customer-facing docs against the code: about 5,200 concrete
claims (env vars, endpoints, flags, defaults, ports, UI labels), plus every
environment variable the code reads. Each discrepancy was re-verified
against the source before editing, and every edit was reviewed again.

What users would have hit following the old text:
- UI paths and labels that no longer exist (Settings > Relay, Platform
  connections, Access Control, SSO Providers, Create Organization) and
  Patrol mode names (now Ask first, Safe auto-fix, Autopilot).
- Wrong values and behaviour: LOG_MAX_AGE=0 does not disable cleanup,
  Patrol evidence budget is 10 calls and 12 turns, ALLOW_UNPROTECTED_EXPORT
  covers private networks too, PULSE_AUDIT_ASYNC defaults on.
- Agent install: install.sh ignores PULSE_ENABLE_KUBERNETES and
  PULSE_ENABLE_PROXMOX, rejects --disable-auto-update, and the token
  fallback lives in the state directory.
- API: audit endpoints answer 402 on Community, onboarding QR is GET,
  type=container is rejected, several routes need admin plus a scope.
- HTTP_REDIRECT_PORT was not documented anywhere.

Docs are mirrored under frontend-modern/public/docs, so each change is
applied to both copies. The tests that pinned the old wording (including
three that asserted claims the code contradicts) are updated alongside.

Contract-Neutral: Customer docs corrected to match shipped behaviour; no runtime, API or contract change.
2026-10-11 13:59:56 +01:00

41 lines
1.7 KiB
Text

# Pulse Deployment Environment Variables
# Copy this file next to your docker-compose.yml or into /etc/pulse/.env.
# Values defined here override the UI configuration. Keep the file out of
# version control and restrict permissions (chmod 600) because it can contain
# credentials.
# -----------------------------------------------------------------------------
# Authentication (recommended for Docker or headless installs)
# -----------------------------------------------------------------------------
# Uncomment and set these to skip the first-run setup wizard.
# Plain-text values are automatically hashed on startup, or supply a bcrypt hash.
# PULSE_AUTH_USER=admin
# PULSE_AUTH_PASS=super-secret-password
# API_TOKENS=host-token-1,host-token-2
# API_TOKEN=legacy-fallback-token
# -----------------------------------------------------------------------------
# Optional security toggles
# -----------------------------------------------------------------------------
# PULSE_AUDIT_LOG=true
# -----------------------------------------------------------------------------
# Networking
# -----------------------------------------------------------------------------
# PULSE_PUBLIC_URL=https://pulse.example.com
# ALLOWED_ORIGINS=https://pulse.example.com
# FRONTEND_PORT=7655
# BIND_ADDRESS=0.0.0.0
# -----------------------------------------------------------------------------
# Monitoring and logging
# -----------------------------------------------------------------------------
# DISCOVERY_SUBNET=192.168.50.0/24
# CONNECTION_TIMEOUT=10
# LOG_LEVEL=info
# METRICS_RETENTION_DAYS=7
# -----------------------------------------------------------------------------
# Miscellaneous
# -----------------------------------------------------------------------------
# TZ=UTC