Skip to main content

Configuration

TypeStream is configured using a TOML file.

At startup, the server searches for a typestream.toml file using the TYPESTREAM_CONFIG_PATH environment variable. If not set, it searches:

  1. The current working directory
  2. The /etc/typestream directory

You can also set the full configuration via the TYPESTREAM_CONFIG environment variable.

Default configuration

[grpc]
port = 4242

[sources.kafka.local]
bootstrapServers = "localhost:9092"
schemaRegistry.url = "http://localhost:8081"
fsRefreshRate = 60

gRPC

NameDescriptionDefault
portPort for gRPC requests4242

Sources

Kafka

Each Kafka source is configured under [sources.kafka.<name>]. The name becomes part of the virtual filesystem path (e.g. local -> /dev/kafka/local/).

NameDescriptionDefault
bootstrapServersComma-separated host:port pairs for the Kafka clusterlocalhost:9092
schemaRegistry.urlSchema Registry URLhttp://localhost:8081
schemaRegistry.userInfoUser info for Schema Registry authentication
sasl.mechanismSASL mechanism for Kafka authenticationPLAIN
sasl.jaasConfigJAAS configuration for Kafka authentication
fsRefreshRateVirtual filesystem refresh interval in seconds60

Required fields are shown in bold.