Skip to content

Configuration

This page lists commonly used flags and environment variables for the server, workers, and CLI. Values can be set via CLI flags or environment variables; environment variables are shown in ALL_CAPS.

Server (lyftdata run server)

LyftData serves HTTPS by default (self-signed if you do not provide TLS material). Most production deployments configure a trusted certificate or terminate TLS behind a reverse proxy—see Networking & TLS.

SettingFlagEnvDefaultNotes
Bind address--bind-addressLYFTDATA_BIND_ADDRESS127.0.0.1:3000Use 0.0.0.0:3000 to accept remote connections.
Disable TLS--disable-tlsoffServe HTTP only (use behind a TLS-terminating reverse proxy, or for local-only eval).
TLS certificate--tls-certLYFTDATA_TLS_CERTRequires --tls-key.
TLS private key--tls-keyLYFTDATA_TLS_KEYRequires --tls-cert.
Staging directory--staging-dirLYFTDATA_STAGING_DIROS defaultRecommended for services; stores control-plane state and logs.
Accept EULA non-interactivelyLYFTDATA_LICENSE_EULA_ACCEPTSet to yes, true, or 1 on first run to avoid prompts in automation.
Admin bootstrap password--admin-init-passwordLYFTDATA_ADMIN_INIT_PASSWORDunsetIf unset, a password is generated and logged on first run.
Retention (days)--db-retention-daysLYFTDATA_LOG_RETENTION_DAYS30Cleanup applies when retention or disk thresholds are reached.
Disk usage threshold (%)--disk-usage-max-percentageLYFTDATA_DB_DISK_USE_MAX_PERCENT80Cleanup attempts begin when disk usage exceeds the threshold.
Bootstrap license--bootstrap-licenseLYFTDATA_LICENSEunsetApply a license non-interactively at startup (automation/scripted installs).

For the full server flag catalog, see lyftdata run server --help.

Worker (lyftdata-worker)

External workers connect to the server using LYFTDATA_URL and authenticate using either a pre-issued API key or auto-enrollment. The worker binary defaults to http://localhost:3000, but most deployments should set an explicit https://... server URL.

SettingFlagEnvDefaultNotes
Server URL--urlLYFTDATA_URLhttp://localhost:3000Worker default is http://localhost:3000 for local compatibility. In most setups set https://…; use http://… only when the server runs with --disable-tls.
Worker ID--worker-idLYFTDATA_WORKER_IDunsetIf unset, the worker can persist identity locally after enrollment.
Worker API key--worker-api-keyLYFTDATA_WORKER_API_KEYunsetRequired for pre-issued auth; keep it secret.
Auto-enrollment key--auto-enrollment-keyLYFTDATA_AUTO_ENROLLMENT_KEYunsetAlternative to pre-issued API keys; use only on trusted networks.
Worker name--worker-nameLYFTDATA_WORKER_NAMEunsetHuman-friendly label for dashboards.
Jobs directory--worker-jobs-dirLYFTDATA_JOBS_DIROS defaultRecommended for services; stores cached job configs and local state.
Startup state reset--reset-stateunsetOne-time troubleshooting reset mode: auth, repair, or full.
Insecure TLS (evaluation only)--tls-insecureLYFTDATA_TLS_INSECUREoffAccept self-signed certificates until you install a trusted certificate.

For the full worker flag catalog, see lyftdata-worker --help.

Notes

  • Prefer setting secrets via environment files managed by your service manager.
  • Keep ports firewalled to trusted networks; see Security hardening.
  • For troubleshooting and quick checks, see Troubleshooting.