Skip to content

Configuration

  • A config file path, usually oriel.toml
  • PostgreSQL metadata DSN
  • ClickHouse DSN
  • Valkey DSN

Oriel loads oriel.toml by default:

Terminal window
oriel serve --config /etc/oriel/oriel.toml

The config path can also come from:

Terminal window
ORIEL_CONFIG=/etc/oriel/oriel.toml oriel serve

A missing config file is an error only when the path was explicitly named. Environment variables override TOML values.

Minimum production config:

[server]
http_addr = ":6743"
public_url = "https://oriel.example.com"
[ingest]
grpc_addr = ":4317"
http_addr = ":4318"
http_on_server = false
[clickhouse]
dsn = "clickhouse://oriel:oriel@clickhouse:9000/oriel"
[metadata]
dsn = "postgres://oriel:oriel@postgres:5432/oriel"
[valkey]
dsn = "valkey://valkey:6379/0"

Set ingest.http_on_server = true only for oriel serve --role=all when you want OTLP/HTTP accepted on the API/UI port as well as the dedicated ingest.http_addr listener.

Run:

Terminal window
oriel --config /etc/oriel/oriel.toml doctor

doctor checks metadata connectivity, ClickHouse connectivity, Valkey connectivity, schema status, ClickHouse version, clock skew, TLS/plaintext listener safety, and disk headroom.

  • Keep a copy of the last known-good oriel.toml.
  • Move secrets to environment variables or an operator-managed config file.
  • If a non-loopback plaintext bind fails startup, either configure TLS or set server.insecure = true intentionally.

See the configuration reference for every key and environment override.