Configuration

Environment Variables

Here we cover environment variables used to configure the Server, Workers and CLI.

Note

Some configuration and/or startup options do not have environment variable equivalents. Use --help for additional parameters on the relevant CLI commands.

Server

Settings here apply to edgeiq run server and edgeiq run worker. Options without environment variables are omitted:

CLI/Environment Variable	Default	Description
—staging-dir EDGEIQ_STAGING_DIR	~/.local/edgeiq	The data/working directory
—auto-enrollment-key EDGEIQ_AUTO_ENROLLMENT_KEY	none	The shared secret for Worker enrollments
—bind-address EDGEIQ_BIND_ADDRESS	127.0.0.1:3000	The Server HTTP API will be served on this address and port. Use 0.0.0.0:3000 for all network interfaces
—disk-usage-max-percentage EDGEIQ_DB_DISK_USE_MAX_PERCENT	80	Logs and metric data will be removed when the staging directory volume exceeds this threshold
—jwt-psk EDGEIQ_JWT_PSK	Auto-generated	Preshared JWT signing key
—log-retention-days EDGEIQ_LOG_RETENTION_DAYS	30	The maximum number of days that logs should be retained
—tls-cert EDGEIQ_TLS_CERT	none	Path to TLS certificate file (if using TLS)
—tls-key EDGEIQ_TLS_KEY	none	Path to TLS key (if using TLS)
n/a EDGEIQ_LICENSE	none	Used to provide the Server with a license key. If present, it will override existing licenses on every startup
n/a EDGEIQ_LICENSE_EULA_ACCEPT	none	Used to accept the EULA on startup. Sometimes needed for automation and other operational requirements

Worker

Settings here apply to worker. Options without environment variables are omitted:

CLI/Environment Variable	Default	Description
—edgeiq-worker-api-key EDGEIQ_WORKER_API_KEY	n/a	API key for this Worker
—edgeiq-worker-id EDGEIQ_WORKER_ID	auto-generated	Unique ID. Used to identify this Worker
—worker-api-bind-address EDGEIQ_WORKER_API_BIND_ADDRESS	127.0.0.1:4041 127.0.0.1:3041	Listening address for new internal job-worker protocol. Port 3041 by default on the Server’s built-in Worker. Otherwise 4041
—edgeiq-worker-name EDGEIQ_WORKER_NAME	n/a	Name for this Worker
—edgeiq-url EDGEIQ_URL	http://localhost:3000	URL where the Server API can be reached
—auto-enrollment-key EDGEIQ_AUTO_ENROLLMENT_KEY	n/a	Enrollment secret if auto-enrollment is enabled on the Server
—jobs-dir EDGEIQ_JOBS_DIR	n/a	Directory where jobs are stored, defaulting to user cache directory
—metrics-interval EDGEIQ_WORKER_METRICS_INTERVAL	60	Send metrics to Server at this interval (seconds)
—tags EDGEIQ_WORKER_LABELS	n/a	Labels to attach to Worker system information

CLI

Settings here apply to administrative commands. These commands are a CLI wrapper to the Server HTTP API:

Environment Variable	Default	Description
EDGEIQ_URL	http://localhost:3000	Server URL