Configuration

Twerk reads TOML configuration from files and environment variables.

Config File Locations

Twerk checks these locations in order:

1. ./config.local.toml
2. ./config.toml
3. ./config.local.yaml
4. ./config.yaml
5. ./config.local.yml
6. ./config.yml
7. ~/twerk/config.toml
8. ~/twerk/config.yaml
9. /etc/twerk/config.toml
10. /etc/twerk/config.yaml

.yaml and .yml filenames are legacy compatibility names only. Their contents must still be valid TOML.

Or specify a file directly:

TWERK_CONFIG=/path/to/config.toml twerk server start standalone

Environment Variables

Override any setting with:

TWERK_<SECTION>_<KEY>=value

Example: TWERK_LOGGING_LEVEL=debug

Local Standalone Example

[logging]
level = "info"
format = "pretty"

[broker]
type = "inmemory"

[datastore]
type = "inmemory"

[coordinator]
address = "localhost:8000"

[worker]
address = "localhost:8001"

[runtime]
type = "shell"

[runtime.shell]
cmd = ["bash", "-c"]
uid = ""
gid = ""

This is the same shape as the repo-root config.toml used for the primary local docs journey.

Distributed Example

[broker]
type = "rabbitmq"

[broker.rabbitmq]
url = "amqp://guest:guest@localhost:5672/"

[datastore]
type = "postgres"

[datastore.postgres]
dsn = "host=localhost user=twerk password=twerk dbname=twerk port=5432 sslmode=disable"

[runtime]
type = "docker"

Use docker or podman when your task definitions include container images.

For a fuller reference, see configs/sample.config.toml in the repository.

Environment Variable Reference

Next Steps

• REST API — API reference
• Quick Start — Get started