Skip to main content

Configure the server

Configure your Tourbillon server using a single file.

Tourbillon runs using a single command:

tourbillon run

The command requires a Tourbillon configuration named tourbillon.toml that defines:

  • Logging configuration
  • The API Key for admin requests
  • The host and port for the Admin service
  • The host and port for the Frontend service
  • Storage/persistence configuration
tourbillon.toml
# logging
log = { type = "console", level = "debug" }

# credentials
api_key = "<API-KEY>"

# services
admin_grpc_server = { address = "0.0.0.0:2424" }
grpc_server = { address = "0.0.0.0:4242" }

# storage
[persistence]
pulsar = { broker_url = "pulsar://pulsar:6650", admin_api_url = "http://pulsar:8080", tenant_name = "default" }

Encrypted Configuration

Tourbillon supports SOPS encrypted configurations.

Encrypt your tourbillon.toml using your chosen adapter and write the result to a new file named tourbillon.enc.toml.

Provide the relevant adapter environment values to tourbillon run and Tourbillon will handle the rest. For example; you have AGE to encrypt your configuration:

SOPS_AGE_KEY="<AGE_KEY> tourbillon run

Standalone

info

Requires a running container service (e.g Docker, OrbStack, Podman)

If you wish to run Tourbillon with "ephemeral" storage; set the following CLI flag:

tourbillon run --standalone

Or set the following in your tourbillon.toml:

tourbillon.toml
standalone = true