License configuration

This is the full configuration reference for your Production License. Use these environment variables to control launcher behavior, public access, branding, authentication, email delivery, and more.

Set these values in your runtime .env or enterprise.env file before starting the deployment.

Enterprise launcher

The enterprise launcher starts and coordinates the services in your production stack. Use these variables to connect the launcher to shared infrastructure and provide the license used at startup.

.env

ENTERPRISE_POSTGRES_URL=postgres://user:password@host:5432/postgres?sslmode=require
ENTERPRISE_REDIS_URL=redis://host:6379/0
ENTERPRISE_LICENSE_B64=your_base64_license_string
ENTERPRISE_LICENSE_FILE=/run/secrets/blnk-enterprise.lic

# Core and Cloud use separate databases on the Postgres instance above
# Defaults: blnk (Core ledger) and blnk-cloud (Cloud Dashboard)
ENTERPRISE_CORE_DB_NAME=blnk
ENTERPRISE_PLANE_DB_NAME=blnk-cloud

Environment variable	Default	Description
`ENTERPRISE_POSTGRES_URL`	—	Postgres connection string used by the launcher to derive the Core and Plane database connections. Point this at the Postgres server that hosts both databases.
`ENTERPRISE_REDIS_URL`	—	Redis connection string passed to Core for queueing, caching, and other Redis-backed runtime work.
`ENTERPRISE_LICENSE_B64`	—	Base64-encoded license string from your onboarding email. Takes precedence over `ENTERPRISE_LICENSE_FILE` when both are set.
`ENTERPRISE_LICENSE_FILE`	—	Path to your `.lic` license file mounted into the container. Use this instead of `ENTERPRISE_LICENSE_B64` when you mount the license as a file.
`ENTERPRISE_CORE_DB_NAME`	`blnk`	Name of the Postgres database the launcher assigns to Blnk Core ledger data.
`ENTERPRISE_PLANE_DB_NAME`	`blnk-cloud`	Name of the Postgres database the launcher assigns to Plane, which powers the Cloud Dashboard.

Bundled services

The production license ships Core, workers, Watch, and query-agent bootstrap in a single enterprise image. Use these variables when you want to run Cloud and Plane only and manage those services separately.

.env

ENTERPRISE_SKIP_CORE=true
ENTERPRISE_SKIP_MIGRATIONS=true
ENTERPRISE_SKIP_WORKERS=true
ENTERPRISE_SKIP_WATCH=true
ENTERPRISE_SKIP_QUERY_AGENT=true

Environment variable	Default	Description
`ENTERPRISE_SKIP_CORE`	`true`	Do not start bundled Core in the image.
`ENTERPRISE_SKIP_MIGRATIONS`	`true`	Do not run Core migrations. Implied when `ENTERPRISE_SKIP_CORE=true`.
`ENTERPRISE_SKIP_WORKERS`	`true`	Do not start Core workers. Implied when `ENTERPRISE_SKIP_CORE=true`.
`ENTERPRISE_SKIP_WATCH`	`true`	Do not start bundled Watch.
`ENTERPRISE_SKIP_QUERY_AGENT`	`true`	Do not bootstrap query-agent.

Public app configuration

These variables control how users reach the deployment and how the launcher connects the internal services. Use the public values for browser access and the internal port values only when you need to change service bindings.

.env

ENTERPRISE_PUBLIC_PORT=8080
ENTERPRISE_PUBLIC_URL=https://ledger.yourdomain.com
ENTERPRISE_CORE_PORT=5001
ENTERPRISE_WORKERS_PORT=5004
ENTERPRISE_WATCH_PORT=8081
ENTERPRISE_UI_PORT=3001

Environment variable	Default	Description
`ENTERPRISE_PUBLIC_PORT`	`8080`	Port the launcher exposes for the public Plane gateway. Map your host or load balancer to this port when running the deployment.
`ENTERPRISE_PUBLIC_URL`	—	Public URL where users open the Cloud Dashboard, including the scheme such as `https://`. Use the same origin in `CORS_ORIGINS`.
`ENTERPRISE_CORE_PORT`	`5001`	Internal port used by the Blnk Core API process.
`ENTERPRISE_WORKERS_PORT`	`5004`	Internal port used by the Core workers monitoring endpoint.
`ENTERPRISE_WATCH_PORT`	`8081`	Internal port used by the bundled Watch service.
`ENTERPRISE_UI_PORT`	`3001`	Internal port used by the Cloud Dashboard UI process.

Custom branding

Customize the Cloud Dashboard theme to match your brand colours. Set your organization name and primary colour so the dashboard feels like your product, not a generic install.

.env

ENTERPRISE_BRAND_NAME=Acme Ledger
ENTERPRISE_BRAND_PRIMARY_COLOR="#A34EF4"
ENTERPRISE_BRAND_LOGO_URL=https://cdn.acme.com/logo.svg
ENTERPRISE_BRAND_FAVICON_URL=https://cdn.acme.com/favicon.ico
ENTERPRISE_BRAND_OG_IMAGE_URL=https://cdn.acme.com/og-image.png
ENTERPRISE_BRAND_HELPER_LINKS_JSON={"ledgers":"https://docs.acme.com/ledgers","balances":"https://docs.acme.com/balances"}

Environment variable	Default	Description
`ENTERPRISE_BRAND_NAME`	—	Display name used for your deployment in the Cloud Dashboard.
`ENTERPRISE_BRAND_PRIMARY_COLOR`	—	Primary accent color used by the Cloud Dashboard UI. Use a six-digit hex color value, such as `"#A34EF4"`.
`ENTERPRISE_BRAND_LOGO_URL`	—	URL for the logo shown in the Cloud Dashboard.
`ENTERPRISE_BRAND_FAVICON_URL`	—	URL for the browser favicon.
`ENTERPRISE_BRAND_OG_IMAGE_URL`	—	URL for the Open Graph preview image.
`ENTERPRISE_BRAND_HELPER_LINKS_JSON`	—	JSON object that overrides learn-more banner and CTA links in Cloud. Supported keys: `ledgers`, `ledgerDetails`, `balances`, `transactions`, `identities`, `reconciliation`, `alerts`.

Security & authentication

These variables configure browser access, local authentication, and encryption for Plane.

.env

CORS_ORIGINS=http://localhost:8080,http://localhost:3001
JWT_SECRET=thisisasecret
BLNK_ENCRYPTION_KEY=0123456789abcdef0123456789abcdef

Environment variable	Default	Description
`CORS_ORIGINS`	—	Comma-separated list of browser origins allowed to call the Plane API. Do not include spaces. Include `ENTERPRISE_PUBLIC_URL` so the Cloud Dashboard can reach the API.
`JWT_SECRET`	—	Strong random secret used to sign and verify local authentication tokens. Store this as a secret and keep it stable across restarts.
`BLNK_ENCRYPTION_KEY`	—	Unique 32-character key used to encrypt sensitive data, including instance connection keys. Do not change it after deployment because existing encrypted data may become unreadable.

Email handling

Configure SMTP so Plane can send login alerts, password resets, and other Cloud notifications from your deployment. If you do not already have an SMTP provider, services such as Resend, SendGrid, or Amazon SES can be used.

SMTP is optional. You can skip these variables if you do not need email notifications yet.

.env

EMAIL_PROVIDER=smtp
SMTP_HOST=
SMTP_PORT=587
SMTP_AUTH_USERNAME=
SMTP_AUTH_PASSWORD=
SMTP_TLS_MODE=auto
SMTP_SKIP_TLS_VERIFY=false

Environment variable	Default	Description
`EMAIL_PROVIDER`	—	Email transport Plane should use. Set this to `smtp`, or leave it unset so Plane uses SMTP when `SMTP_HOST` is configured.
`SMTP_HOST`	—	Hostname of the SMTP server that sends mail for your deployment.
`SMTP_PORT`	`587`	Port your SMTP server listens on. Use the value required by your provider.
`SMTP_AUTH_USERNAME`	—	Username used for SMTP authentication. Some providers require a fixed username such as `resend`.
`SMTP_AUTH_PASSWORD`	—	Password or API key used for SMTP authentication. Store this as a secret.
`SMTP_TLS_MODE`	`auto`	TLS mode Plane uses for the SMTP connection. Use `auto` for STARTTLS-capable servers unless your provider requires another supported mode.
`SMTP_SKIP_TLS_VERIFY`	`false`	Whether to skip TLS certificate verification. Use `false` in production.

Cold storage

Configure object-storage archiving for your Lake service. When enabled, Lake copies eligible older transactions, balances, ledgers, and identities into verified Parquet files while hot Postgres stays lean. Lake keeps archive indexes in sync and leaves hot database rows untouched unless purge is explicitly enabled.

.env

LAKE_ENABLED=true
LAKE_ARCHIVER_ENABLED=true
LAKE_S3_BUCKET=your-bucket
LAKE_S3_ENDPOINT=https://your-s3-endpoint
LAKE_S3_ACCESS_KEY_ID=
LAKE_S3_SECRET_ACCESS_KEY=
LAKE_S3_REGION=auto
LAKE_S3_PATH_STYLE=true

Environment variable	Default	Description
`LAKE_ENABLED`	`false`	Turns on the lake feature in Plane.
`LAKE_ARCHIVER_ENABLED`	`false`	Starts the background worker that archives eligible old rows.
`LAKE_S3_BUCKET`	—	Object storage bucket where Parquet archive files and index files are stored.
`LAKE_S3_ENDPOINT`	—	S3-compatible endpoint (e.g., DigitalOcean Spaces, R2, MinIO, or AWS S3 endpoint).
`LAKE_S3_ACCESS_KEY_ID`	—	Access key used by Plane to write/read archive objects.
`LAKE_S3_SECRET_ACCESS_KEY`	—	Secret key used with the access key. Store this as a secret.
`LAKE_S3_REGION`	`auto`	Region passed to the S3 client. `auto` is useful for S3-compatible providers.
`LAKE_S3_PATH_STYLE`	`true`	When set to `true`, uses path-style object URLs (`endpoint/bucket/object-key`) instead of virtual-host style (`bucket.endpoint/object-key`).

Monitoring

Configure object-storage persistence for your Monitoring service. When set, Monitoring stores traces, metrics, and logs captured from connected instances in your configured S3-compatible bucket so they can be retained and retrieved outside the control-plane database.

.env

MONITORING_STORAGE_S3_BUCKET=
MONITORING_STORAGE_S3_ENDPOINT=
MONITORING_STORAGE_S3_ACCESS_KEY_ID=
MONITORING_STORAGE_S3_SECRET_ACCESS_KEY=
MONITORING_STORAGE_S3_REGION=auto
MONITORING_STORAGE_S3_PATH_STYLE=true

Environment variable	Default	Description
`MONITORING_STORAGE_S3_BUCKET`	—	Object storage bucket where Monitoring payloads are stored.
`MONITORING_STORAGE_S3_ENDPOINT`	—	S3-compatible endpoint (e.g., DigitalOcean Spaces, R2, MinIO, or AWS S3 endpoint).
`MONITORING_STORAGE_S3_ACCESS_KEY_ID`	—	Access key used by Monitoring to write/read stored payloads.
`MONITORING_STORAGE_S3_SECRET_ACCESS_KEY`	—	Secret key used with the access key. Store this as a secret.
`MONITORING_STORAGE_S3_REGION`	`auto`	Region passed to the S3 client.
`MONITORING_STORAGE_S3_PATH_STYLE`	`true`	When set to `true`, uses path-style object URLs instead of virtual-host style.

Watch

Configure Git-based rule loading for your Watch service. When WATCH_SCRIPT_GIT_REPO is set, Watch clones the repository, loads .ws rule files from it, and keeps the local copy in sync. For additional Watch settings, see Watch configuration.

.env

WATCH_SCRIPT_GIT_REPO=
WATCH_SCRIPT_GIT_BRANCH=main
WATCH_SCRIPT_GIT_USERNAME=x-access-token
WATCH_SCRIPT_GIT_TOKEN=

Environment variable	Default	Description
`WATCH_SCRIPT_GIT_REPO`	—	Git repository URL containing Watch rule files. When set, Watch loads rules from this repository instead of relying only on local files.
`WATCH_SCRIPT_GIT_BRANCH`	`main`	Git branch Watch tracks when `WATCH_SCRIPT_GIT_REPO` is set. Use the branch that contains the rules for this deployment.
`WATCH_SCRIPT_GIT_USERNAME`	`x-access-token`	Username used to authenticate when cloning a private rules repository over HTTPS.
`WATCH_SCRIPT_GIT_TOKEN`	—	Personal access token or password used with `WATCH_SCRIPT_GIT_USERNAME` for private repository access. Store this as a secret.

Start Here

Instances

Ledgers

Balances

Transactions

Identities

Reconciliation

Filters & Views

Alerts

Insights

Settings

Integrations

Enterprise launcher

Bundled services

Public app configuration

Custom branding

Security & authentication

Email handling

Cold storage

Monitoring

Watch

​Enterprise launcher

​Bundled services

​Public app configuration

​Custom branding

​Security & authentication

​Email handling

​Cold storage

​Monitoring

​Watch

Enterprise launcher

Bundled services

Public app configuration

Custom branding

Security & authentication

Email handling

Cold storage

Monitoring

Watch