Configuration¶

Aurum user configuration has four public locations: the Aurum home, its aurum.toml runtime file, the remote registry, and credential documents. Managed launch values are generated by the product and should not be copied into user configuration.

Aurum home¶

Resolution order is:

the CLI --home <path> option;
AURUM_HOME;
$HOME/.aurum;
/tmp/aurum-home-<uid> when HOME is unavailable.

The released layout is:

$AURUM_HOME/
|-- aurum.toml
|-- remotes.toml
|-- secrets/
|-- projects/
`-- instances/

Only aurum.toml, remotes.toml, and files under secrets/ are user configuration. Project and instance directories are product-managed state.

Runtime file¶

The CLI creates $AURUM_HOME/aurum.toml on first use. It accepts a restricted KEY = value format with comments and optional quoted values. Supported user-facing keys are:

Key	Meaning
`AURUM_ENABLE_PROXY`	Boolean switch for exchange HTTP and WebSocket proxy use.
`AURUM_HTTP_PROXY`	Proxy URL, for example `http://127.0.0.1:7890`.
`AURUM_LOG_LEVEL`	Runtime level: `trace`, `debug`, `info`, `warn`, `error`, or `fatal`.
`AURUM_LOG_COLOR`	Enable or disable console color.
`AURUM_CONNECT_TIMEOUT_MS`	Outbound connection timeout in milliseconds.
`AURUM_READ_TIMEOUT_MS`	Outbound read timeout in milliseconds.

AURUM_ENABLE_PROXY = true
AURUM_HTTP_PROXY = "http://127.0.0.1:7890"
AURUM_LOG_LEVEL = "info"

Unknown AURUM_* keys can be passed to the project process for forward-compatible release configuration, but they are not a stable interface until documented by the consuming product. CLICKHOUSE_* values are managed telemetry configuration and are not strategy-author settings.

Command overrides¶

aurum run --log overrides the foreground log level. aurum run --auth selects credentials. --home changes the entire configuration and state root for that command.

Remote registry¶

Use aurum remote commands to edit remotes.toml. Do not hand-edit it during a CLI operation. Each entry has a name and an SSH address of the form user@host[:port]; one entry may be the default push target.

Terminal connections are not stored here. Terminal saves public Forge HTTP base URLs in its own connection registry.

Credentials¶

aurum run --auth <ref> resolves references as follows:

Reference	File
`okx-live`	`$AURUM_HOME/secrets/okx-live.toml`
`okx/live`	`$AURUM_HOME/secrets/okx/live.toml`
`file:///secure/okx.toml`	Exact absolute path.

A credential document contains one or more account tables:

[[accounts]]
venue = "okx"
name = "trading"
permissions = "READ,TRADE"
api_key = "..."
api_secret = "..."
passphrase = "..."

The account must match the venue, credential reference or qualified account name, and requested permission set. Protect credential files with mode 0600 and the parent directory with mode 0700. Never include credentials in a project directory or deployment source archive.

Process environment¶

The product sets runtime identity, ports, run directories, journal delivery, and history delivery variables when starting an installed instance. They are observable implementation inputs, not configuration that strategy authors should set manually.

The supported direct environment overrides for user workflows are AURUM_HOME and the documented AURUM_* runtime keys above. Prefer aurum.toml for persistent values and CLI options for one command.