Docs / Configuration Build
Environment Variables
Every variable EKOS reads.
| Variable | Description | Default |
|---|---|---|
EKOS_CONFIG |
Path to ekos.toml (used when --config is absent) |
./ekos.toml |
EKOS_WORKSPACE |
Workspace for ekos mcp serve when no --workspace is given |
current dir |
EKOS_HOME |
The EKOS home holding projects (--home); also where the installer puts it |
~/.ekos |
EKOS_PROJECT, EKOS_TENANT |
Same as --project / --tenant |
unset / default |
EKOS_READ_SCOPE |
Same as --read-scope (for mcp serve, ekl, query) |
unset |
EKOS_LOG |
Log filter, overrides [workspace] log-level |
from config |
EKOS_LOG_FORMAT |
pretty or json |
from config |
EKOS_RUN_LOG |
File the run log is written to, instead of <state>/runs/<stamp>-<command>.jsonl |
unset |
EKOS_MCP_TOKEN |
Bearer token for --tcp / --http when --token-file is absent |
unset |
ANTHROPIC_API_KEY |
Key for provider = "anthropic" |
— |
OPENAI_API_KEY |
Key for provider = "openai" (and OpenAI embeddings) |
— |
OPENCODE_API_KEY |
Key for provider = "zen" (OpenCode Zen) |
— |
OPENAI_BASE_URL |
OpenAI-compatible host when [llm] base-url is unset |
OpenAI |
OPENAI_MODEL |
OpenAI-compatible model when [llm] model is unset |
— |
OLLAMA_BASE_URL |
Ollama endpoint | http://localhost:11434 |
OLLAMA_MODEL |
Ollama model when [llm] model is unset |
llama3.1:8b |
OLLAMA_NUM_CTX |
Ollama num_ctx when [llm] context-window is unset |
8192 |
(the name in password-env) |
A [[databases]] entry's password; ekos.toml holds only the variable's name |
— |
EKOS_GITHUB_OWNER, EKOS_GITHUB_REPO |
Enable the GitHub connector | unset |
EKOS_GITHUB_TOKEN |
Optional GitHub token | unset |
EKOS_GITHUB_PER_PAGE, EKOS_GITHUB_MAX_PAGES |
Paging limits | connector defaults |
EKOS_CONFLUENCE_BASE_URL, EKOS_CONFLUENCE_SPACE |
Enable the Confluence connector | unset |
EKOS_CONFLUENCE_TOKEN |
Optional Confluence token | unset |
EKOS_CRYPTO_EXPORT_DIR |
Enable the crypto connector | unset |
EKOS_TREASURY_ADDRESS, EKOS_TREASURY_CHAIN_ID |
Enable the DAO treasury connector (RFC 0032) | unset |
EKOS_TREASURY_EXPLORER_URL, EKOS_TREASURY_API_KEY |
Explorer endpoint (default: Etherscan multichain v2) and key | default URL / unset |
EKOS_SNAPSHOT_SPACE |
Enable the Snapshot governance connector, e.g. ens.eth (RFC 0032) |
unset |
EKOS_SNAPSHOT_HUB_URL |
Snapshot GraphQL endpoint | https://hub.snapshot.org/graphql |
EKOS_CLICKHOUSE_URL, _USER, _PASSWORD, _DATABASE |
ClickHouse connection | unset |
The name of the LLM key variable is configurable: [llm] api-key-env = "OPENCODE_API_KEY" reads whichever variable you name.
Prefer environment variables (or a secret manager) to putting keys in ekos.toml, which is usually committed.
Installer, console and container
| Variable | Read by | Description |
|---|---|---|
EKOS_INSTALL_DIR |
install.sh |
where the binary goes (default ~/.ekos/bin) |
EKOS_VERSION |
install.sh |
pin a release, e.g. v1.2.0 |
EKOS_CLI_ONLY |
install.sh |
1: the command only, without the web console |
EKOS_CONSOLE_MODE, EKOS_CONSOLE_HOST, EKOS_CONSOLE_PORT |
ekos console |
team or local, the address (default 127.0.0.1:8000); local mode refuses a non-loopback host |
EKOS_CONSOLE_* |
the web console | every console setting, e.g. EKOS_CONSOLE_OIDC_ISSUER, EKOS_CONSOLE_OWNERS, EKOS_CONSOLE_PRODUCTION; a variable wins over <home>/control/console.toml |
EKOS_DB_<TENANT>_<PROJECT>_<DATABASE> |
the web console | where the console keeps a database password it was given on the Sources tab |
EKOS_SECRETS_DIR |
the container image's entrypoint | every file there whose name is a valid variable name becomes that variable |
LD_LIBRARY_PATH, TNS_ADMIN |
the Oracle driver | where Oracle Instant Client is |
The full list of console settings is in Deployment.