DorkOSDorkOS
Getting Started

Configuration

Environment variables and configuration options for DorkOS

Configuration

DorkOS is configured via environment variables and a persistent config file at ~/.dork/config.json. CLI flags take highest precedence; built-in defaults apply when nothing else is set.

Config precedence: CLI flags > environment variables > ~/.dork/config.json > built-in defaults.

Required

Prop

Type

Optional

Prop

Type

Tunnel Configuration

DorkOS supports ngrok tunnels for remote access. See the Tunnel Setup guide for full details.

Prop

Type

Always set TUNNEL_AUTH when exposing DorkOS publicly via a tunnel. Without it, anyone with the tunnel URL can access your sessions.

Relay Configuration

DorkOS includes a subject-based pub/sub message bus for inter-agent communication. See the Relay Messaging guide for setup details.

Prop

Type

Mesh Configuration

Mesh provides agent discovery, health monitoring, and network topology visualization. See the Agent Discovery guide for setup details.

Prop

Type

Config Directory

DorkOS creates a ~/.dork/ directory on startup for storing configuration. Structured logs are written to ~/.dork/logs/dorkos.log as NDJSON (newline-delimited JSON).

Use dorkos config path to print the path to your config file, and dorkos config list to view all active settings.

Next Steps