Deployment guide
Use this guide to deploy Blnk Production License on AWS, GCP, Azure, or any cloud provider.Get your Production License
After purchasing a Production License, you’ll receive an email with your license details.Your license details will include a base64-encoded license string, which is the recommended way to activate your license. You may also receive a license file named
blnk-enterprise.lic. Both contain the same license information and enabled features.Prepare your databases
Set up a managed Postgres instance and a managed Redis instance in your cloud provider before continuing.
- Postgres
- Redis
Create a managed Postgres instance in your environment, such as Amazon RDS, Google Cloud SQL, or Azure Database for PostgreSQL. Use a recent supported Postgres version and enable TLS for production.Once the instance is ready, create two databases: one for Blnk Core and one for Blnk Cloud.Keeping these databases separate isolates ledger data from Cloud management data.
Pull the Docker image
Pull the enterprise image from GitHub Container Registry:
Docker
Using a custom image? Use the image name provided in your license email or onboarding instructions.
Add primary environment variables
Create an environment file, such as
.env or enterprise.env.Add the following variables and replace the placeholder values with your Postgres URL, Redis URL, and license string..env
| Environment variable | Description |
|---|---|
HOSTNAME | Use 127.0.0.1 so health checks and internal services communicate through the container loopback interface. |
ENTERPRISE_POSTGRES_URL | Connection string for your Postgres instance. |
ENTERPRISE_REDIS_URL | Connection string for your Redis instance. |
ENTERPRISE_LICENSE_B64 | Base64-encoded license string from Step 1. Takes precedence over ENTERPRISE_LICENSE_FILE. To use a file instead, set ENTERPRISE_LICENSE_FILE to the path of your .lic file. |
Set up public app config
Add these variables to the same environment file. They configure how users access the Cloud Dashboard.
.env
| Environment variable | Description |
|---|---|
ENTERPRISE_PUBLIC_PORT | Port exposed by the enterprise launcher for the Cloud Dashboard. |
ENTERPRISE_PUBLIC_URL | Public URL where users access the Cloud Dashboard, including https://. Use this value when configuring CORS_ORIGINS in the next step. |
Set up Plane Environment variables
Plane powers the Cloud Dashboard and stores its data in the
blnk-cloud database.Add these variables to the same environment file you created in the previous step..env
| Environment variable | Description |
|---|---|
CORS_ORIGINS | Comma-separated list of browser origins allowed to access the Plane API. Do not include spaces. Make sure ENTERPRISE_PUBLIC_URL is included. |
BLNK_ENCRYPTION_KEY | A unique 32-character key used to encrypt sensitive data, such as instance connection keys. Do not change this value after deployment, or previously encrypted data may become unreadable. |
JWT_SECRET | A strong random secret used to sign and verify authentication tokens. |
Run the enterprise image
Start the stack with the image you pulled earlier. Map the host port to Confirm that your deployment is live:
ENTERPRISE_PUBLIC_PORT, e.g. 8080 if you used the value from the public app config step.Docker
If you use a license file instead of
ENTERPRISE_LICENSE_B64, mount blnk-enterprise.lic into the container and set ENTERPRISE_LICENSE_FILE to its path in your env file.Check deployment status
Access the Cloud Dashboard
You are ready to use Cloud in your environment. Open
ENTERPRISE_PUBLIC_URL in your browser.- Sign up and create your account.
- Sign in and set up your workspace.
- Start working with the auto-provisioned Core instance, or connect additional instances to manage more environments.
What’s next
Connect instance
Multiple Core instances via Query Agent.
Working with Blnk Core
Quick start and first transaction.
Navigating Cloud
Dashboard tour and daily operations.