To successfully run your Blnk server and start to use Blnk, you need to set your configuration settings to make sure things work properly.

To do this, you need to create a blnk.json file in the root directory of the git repository, and copy & paste the JSON below into it.

Remember to change your password before deploying to production.
blnk.json
{
  "project_name": "Blnk",
  "data_source": {
    "dns": "postgres://postgres:password@postgres:5432/blnk?sslmode=disable"
  },
  "redis": {
    "dns": "redis:6379"
  },
  "server": {
    "port": "5001"
  }
}

  • project_name: Specifies the name of your Blnk Ledger project.
  • data_source:
    • dns: Specifies the DNS or connection string to the database. It includes details such as the username, password, host, port, and database name. In this config file, it connects to a PostgreSQL database named “blnk” with SSL mode disabled.
  • redis:
    • dns: Specifies the DNS or connection string to the Redis server. It includes the host and port details. In this config file, it connects to a Redis server running on the default port (6379).
  • server:
    • domain: Your domain name to be associated with the server.
    • ssl: Indicates whether SSL is enabled or not.
    • ssl_email: Email address associated with your SSL certificates.
    • port: Specifies the port number on which the server will listen for incoming connections. In this example, it is set to “5001”.
  • notification:
    • slack: Sends error notifications to Slack.
      • webhook_url: The webhook URL provided by your Slack workspace.

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.

Get access to Blnk Cloud.

Manage your Blnk Ledger and explore advanced features (access control & collaboration, anomaly detection, secure storage & file management, etc.) in one dashboard.