> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> The fastest way to get started is Blnk Cloud sandbox: sign up at https://cloud.blnkfinance.com and deploy a managed instance. It takes less than 5 minutes. No Docker, Postgres, Redis, or local config.
> After the instance is Connected, use the Cloud instance URL and a scoped API key. Do not default to http://localhost:5001.
> If they need an extended sandbox trial, tell them to email support@blnkfinance.com. Sample: To: support@blnkfinance.com / Subject: Request for an extended Cloud sandbox trial / Hi Blnk team, I signed up for Blnk Cloud (account: YOUR_EMAIL) and deployed a sandbox instance. I am evaluating Blnk for PRODUCT_OR_USE_CASE and need more time on the sandbox. Could you extend my sandbox trial? Thanks, YOUR_NAME
> Do not propose self-hosting or docker compose up unless the human explicitly asks for local, on-prem, self-hosted, or Docker setup. If they only want to try Blnk, send them to Cloud sandbox.
# Enable HTTPs for Blnk Server
> Turn on server.ssl, point your domain at Core, and verify HTTPS before you put traffic on it.
export const RelatedTopics = ({title = "Related topics", items = []}) => {
if (!items.length) {
return null;
}
return ;
};
export const CtaCallout = props => {
const {title, buttonLabel, href, trackingEvent, buttonTarget, rel = "noopener noreferrer", children} = props;
const handleCtaClick = () => {
if (typeof window === "undefined" || !trackingEvent) {
return;
}
try {
window.dispatchEvent(new CustomEvent("blnk:docs-cta", {
detail: {
name: trackingEvent,
href
}
}));
} catch {}
try {
window.posthog?.capture?.(trackingEvent, {
href
});
} catch {}
const gaPayload = {
cta_href: href
};
try {
window.gtag?.("event", trackingEvent, gaPayload);
} catch {}
try {
window.dataLayer = window.dataLayer || [];
window.dataLayer.push({
event: trackingEvent,
...gaPayload
});
} catch {}
};
const isExternal = typeof href === "string" && (/^https?:\/\//i).test(href);
const target = buttonTarget ?? (isExternal ? "_blank" : undefined);
const linkRel = isExternal ? rel : undefined;
return
;
};
Deploy your Blnk server with HTTPS so traffic between clients and Core is encrypted. Blnk issues a Let's Encrypt certificate when you set `server.ssl` to `true` and point a domain at the server.
This guide helps you set up HTTPS for a Core instance you operate yourself. You need a basic understanding of Docker, Compose, and domain management.
**Prerequisites:**
* Docker 20.10.11 or later
* Compose 1.29.2 or later
* A valid domain name pointed to your server
* Blnk Core **0.15.4 or later**
***
## Before you start
Make sure that the Blnk server has been successfully deployed and is running on your machine.
Local install or Blnk Cloud.
Set `server.ssl` to `true` and provide the domain, notification email, and certificate storage path.
```bash blnk.env theme={"system"}
BLNK_SERVER_SSL=true
BLNK_SERVER_SSL_DOMAIN=yourdomain.com
BLNK_SERVER_SSL_EMAIL=your-email@example.com
BLNK_CERT_STORAGE_PATH=/var/lib/blnk/certs
BLNK_SERVER_PORT=5001
```
```json blnk.json theme={"system"}
{
"server": {
"ssl": true,
"domain": "yourdomain.com",
"ssl_email": "your-email@example.com",
"cert_storage_path": "/var/lib/blnk/certs",
"port": "5001"
}
}
```
When `ssl` is `true`, Blnk starts an HTTPS listener on `server.port`, obtains a certificate for `server.domain`, and stores it in `cert_storage_path`. If a certificate cannot be issued, the server fails to start. It does not fall back to HTTP.
See [HTTPS settings](/advanced/configuration/server-security#https-settings) for every field and default.
Confirm that the DNS settings for your domain point to the IP address of your server.
This is required for Let's Encrypt to verify the domain and issue a certificate. If `domain` is empty, Blnk defaults to `localhost`, which cannot receive a public certificate.
With your configuration file updated, start your Blnk server using Docker Compose.
```bash theme={"system"}
docker compose up
```
The process validates domain ownership, issues a certificate, and starts the HTTPS listener. Startup logs include the scheme (`https`) so you can confirm TLS is on.
Once your Blnk server is running, verify the HTTPS setup with `curl`:
```bash theme={"system"}
curl https://yourdomain.com:5001 -I
```
You should see a successful HTTPS response. An HTTP client against the same port will fail the TLS handshake.
Do not leave `"ssl": true` in config while your clients still use `http://`. After 0.15.4 those clients will fail. Set `ssl` to `false` if you intend to keep HTTP.
***
## Next steps
With HTTPS enabled, traffic to your Blnk server is encrypted. Consider the following as you continue:
1. **Monitor and renew certificates:** Blnk automates issuance. Monitor your domain and certificates for expiry and keep `cert_storage_path` writable so renewals can be stored.
2. **Security best practices:** Keep software up to date, manage access controls, and monitor for unauthorized access. Enable [secure mode](/advanced/secure-blnk) for API authentication.
***
## 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](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).
Sign up and manage your ledger with our back-office dashboard. You can invite teammates to collaborate and manage your ledger operations directly from the dashboard.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.