Backup Configuration

This page covers the settings Blnk uses for backup storage, including the local backup path and the credentials needed for S3-compatible object storage.

Backup settings

Use these settings to choose where backup files are written and how Blnk connects to S3 or another S3-compatible service.

BLNK_BACKUP_DIR=
BLNK_AWS_ACCESS_KEY_ID=
BLNK_AWS_SECRET_ACCESS_KEY=
BLNK_S3_ENDPOINT=
BLNK_S3_BUCKET_NAME=
BLNK_S3_REGION=

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

	Description	Default
`BLNK_BACKUP_DIR`	Local directory path Blnk uses when writing backup files.	None
`BLNK_AWS_ACCESS_KEY_ID`	Access key ID used to authenticate with S3.	None
`BLNK_AWS_SECRET_ACCESS_KEY`	Secret access key used to authenticate with S3.	None
`BLNK_S3_ENDPOINT`	Custom S3 endpoint, usually used for S3-compatible storage providers.	None
`BLNK_S3_BUCKET_NAME`	Bucket name where backup files are stored.	None
`BLNK_S3_REGION`	Region for the S3 bucket.	None

Important: Store BLNK_AWS_ACCESS_KEY_ID and BLNK_AWS_SECRET_ACCESS_KEY as secrets. Do not commit them to version control.

`BLNK_BACKUP_DIR`

Use this to tell Blnk where backup files should be written before they are stored or uploaded. Set a path that your Blnk process can read from and write to. If you are running Blnk in containers, make sure the directory is backed by a mounted volume instead of short-lived container storage.

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.

Observability Configuration

Configuration Reference

Start Here

Ledgers

Ledger balances

Transactions

Reconciliation

Identities

Metadata

Search

Webhooks

API keys

Guides

Configuration

Advanced

Migration guides

Backup settings

`BLNK_BACKUP_DIR`

Need help?

​Backup settings

​BLNK_BACKUP_DIR

​Need help?

Backup settings

`BLNK_BACKUP_DIR`

Need help?