Skip to content

Configuration Reference

Complete reference for config.yaml options.

Full Example

stream:
  id: 1
  pg_connection:
    host: localhost
    port: 5432
    name: mydb
    username: postgres
    password: postgres
    tls:
      enabled: false
      trusted_root_certs: ""
    keepalive: 60
  batch:
    max_size: 1000
    max_fill_secs: 5

sink:
  type: kafka
  brokers: localhost:9092
  topic: events

Stream Configuration

stream.id
Type integer
Required Yes

Unique identifier for this stream. Must match the stream_id in subscription records.

stream.pg_connection

Database connection settings.

host
Type string
Required Yes

Database hostname or IP address.

port
Type integer
Required Yes
Default 5432

Database port.

name
Type string
Required Yes

Database name.

username
Type string
Required Yes

Database username. Must have REPLICATION privilege.

password
Type string
Required Yes

Database password. Supports environment variable substitution: ${ENV_VAR}.

tls.enabled
Type boolean
Required No
Default false

Enable TLS for database connection.

tls.trusted_root_certs
Type string
Required No

Path to CA certificate file for TLS verification.

keepalive
Type integer
Required No
Default 60

TCP keepalive interval in seconds.

stream.batch

Controls how events are grouped before delivery.

max_size
Type integer
Required No
Default 1000

Maximum events per batch. Larger batches improve throughput but increase latency.

max_fill_secs
Type integer
Required No
Default 5

Maximum time to fill a batch in seconds. Lower values reduce latency but may result in smaller batches.

Sink Configuration

The sink section defines the delivery destination. Each sink type has different options.

Common Pattern

sink:
  type: <sink-type>
  # sink-specific options

Available Types

  • memory - Built-in test sink
  • kafka - Apache Kafka
  • nats - NATS messaging
  • rabbitmq - RabbitMQ
  • redis-strings - Redis key-value
  • redis-streams - Redis Streams
  • webhook - HTTP POST
  • sqs - AWS SQS
  • sns - AWS SNS
  • kinesis - AWS Kinesis
  • gcp-pubsub - GCP Pub/Sub
  • elasticsearch - Elasticsearch
  • meilisearch - Meilisearch

See the Sinks section for sink-specific configuration.

Environment Variables

Use ${VAR_NAME} syntax to substitute environment variables:

stream:
  pg_connection:
    password: ${POSTGRES_PASSWORD}

sink:
  type: kafka
  sasl_password: ${KAFKA_PASSWORD}

Configuration File Location

By default, Postgres Stream looks for config.yaml in the current directory.

Override with the CONFIG_PATH environment variable:

CONFIG_PATH=/etc/postgres-stream/config.yaml postgres-stream