Configuring your Blnk server

​

Overview

Customise your Blnk server with our robust configuration system. This configuration is set via the blnk.json file or environment variables with the prefix, BLNK_.

​

Configuration structure

​

Server configuration

The server configuration module provides a centralized way to define your server’s behavior and security settings..

{
  "server": {
    "ssl": false,                  
    "secure": false,               
    "secret_key": "",          
    "domain": "",              
    "email": "",               
    "port": "5001"             
  }
}

​

PII tokenization

This configuration ensures that sensitive data is encrypted and protected during tokenization and detokenization operations.

{
  "tokenization_secret": ""
}

​

Database configuration

The data source configuration establishes the connection between the Blnk server and your database backend.

{
  "data_source": {
    "dns": ""                      
  }
}

​

Redis configuration

The Redis configuration manages the connection to your Redis instance, which is commonly used for caching, session storage, and message queuing.

{
  "redis": {
    "dns": ""                     
  }
}

​

Typesense configuration

The TypeSense configuration manages your connection to the TypeSense search engine, enabling fast and typo-tolerant search functionality in your Blnk server.

{
  "typesense": {
    "dns": ""                         
  },
  "type_sense_key": ""               
}

​

Rate limiting

The rate limiting configuration helps protect the API from abuse and ensures fair resource allocation.

{
  "rate_limit": {
    "requests_per_second": null,     
    "burst": null,                   
    "cleanup_interval_sec": 10800    
  }
}

​

Transaction configuration

The transaction configuration manages how Blnk processes and handles batched operations, controlling throughput and resource utilization.

{
  "transaction": {
    "batch_size": 100000,                
    "max_queue_size": 1000,              
    "max_workers": 10,                   
    "lock_duration": 1800,               
    "index_queue_prefix": "transactions" 
  }
}

​

Reconciliation configuration

The reconciliation configuration handles how the reconciliation engine works.

{
  "reconciliation": {
    "default_strategy": "one_to_one",     
    "progress_interval": 100,             
    "max_retries": 3,                     
    "retry_delay": 5                      
  }
}

​

Queue configuration

The queue configuration defines the various queues used throughout the server for processing different types of operations asynchronously.

{
  "queue": {
    "transaction_queue": "new:transaction",             
    "webhook_queue": "new:webhook",                     
    "index_queue": "new:index",                         
    "inflight_expiry_queue": "new:inflight-expiry",     
    "number_of_queues": 20,
    "insufficient_fund_retries": true,
    "max_retry_attempts": 3                           
  }
}

​

Notification configuration

The notification configuration manages external integrations for system notifications, including Slack alerts and custom webhooks.

{
  "notification": {
    "slack": {
      "webhook_url": ""
    },
    "webhook": {
      "url": "",
      "headers": {}     
    }
  }
}

​

S3 configuration

The S3 configuration manages connection settings for Amazon S3 storage service for system backups and file storage.

{
  "backup_dir": "",                      
  "aws_access_key_id": "",
  "aws_secret_access_key": "",
  "s3_endpoint": "",
  "s3_bucket_name": "",
  "s3_region": ""
}

​

Telemetry

This configuration ensures enables telemetry.

{
  "enable_telemetry": "true"
}

​

Default values & validation

​

Required fields

• Data Source DNS (data_source.dns)
• Redis DNS (redis.dns)

​

Automatic defaults

1. Project name defaults to “Blnk Server”
2. Server port defaults to “5001”
3. TypeSense URL defaults to “http://typesense:8108”
4. Rate limiting:
   • If RPS is set without burst, burst defaults to 2 * RPS
   • If burst is set without RPS, RPS defaults to burst / 2
   • Cleanup interval defaults to 10800 seconds (3 hours)
5. Telemetry is enabled by default

​

Transaction defaults

• Batch size: 100,000
• Max queue size: 1,000
• Max workers: 10
• Lock duration: 1800 seconds
• Index queue prefix: “transactions”

​

Reconciliation defaults

• Default strategy: “one_to_one”
• Progress interval: 100
• Max retries: 3
• Retry delay: 5 seconds

​

Queue defaults

• Transaction queue: “new:transaction”
• Webhook queue: “new:webhook”
• Index queue: “new:index”
• Inflight expiry queue: “new:inflight-expiry”
• Number of queues: 20
• Insufficient retries: false

​

Telemetry defaults

• Enable telemetry: true

​

Configuration loading process

1. Load configuration from JSON file if present.
2. Override with environment variables.
3. Validate required fields.
4. Apply default values.
5. Trim whitespace from string values.
6. Setup rate limiting defaults.

​

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.