Skip to main content
This is the documentation for Blnk’s configuration file. This file defines how your instance runs, including database and Redis connections, transaction processing, security, notifications, observability, and backups. You can set it up using a blnk.json file or environment variables that use the BLNK_ prefix.

​
Configuration structure

Blnk’s configuration is grouped into the following sections. Click through to learn more about each section and its configuration options.

Server & security

Runtime, secure mode, rate limits, and request size caps.

Data stores

PostgreSQL, Redis, and Typesense.

Transactions

Processing, batching, locking, coalescing.

Queues

Names, sharding, retries, hot lanes.

Reconciliations

Strategy, progress updates, retries.

Notifications

Slack and outgoing HTTP webhooks.

Monitoring

Logs, traces, metrics, and monitoring setup.

Observability configuration

Flags and environment variables.

Backups

Local paths and S3 storage.

Reference

Required fields, defaults, options.

​
Minimum required settings

To start Blnk, you only need to set your PostgreSQL and Redis connection URLs. Most of the other configuration settings have sensible defaults that you can leave as-is until you need to change them. 
# Database configuration
BLNK_DATA_SOURCE_DNS="postgres://postgres:password@postgres:5432/blnk?sslmode=disable"

# Redis configuration
BLNK_REDIS_DNS="redis:6379"

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.