Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Configure server runtime, secure mode, tokenization, and rate limits.

Data stores

Set up PostgreSQL, Redis, and Typesense connections.

Transactions & queues

Configure transaction processing, queues, coalescing, and hot-lane routing.

Reconciliations

Configure reconciliation strategy, progress updates, and retries.

Notifications

Configure Slack webhooks and outgoing HTTP webhooks.

Observability

OpenTelemetry traces, HTTP metrics, and optional product heartbeat telemetry.

Backups

Configure backup paths and S3 storage.

Reference

Review required fields, default values, and available 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.
Tip: Connect to Blnk Cloud to see your Core data.You can view your transactions, manage identities, create custom reports, invite other team members to collaborate, and perform operations on your Core — all in one dashboard.Check out Blnk Cloud →