Skip to content
Nokku LogoNokku
GuidesLearn the concepts

How a license key activates more on a self-hosted core, fully offline.

Last updated on

A self-hosted core is free to run, and it works without a license key. A key turns on more features and raises the limits. This page explains how keys work. Get in touch if you need one.

How it works

  • A license key is a signed string. The core checks the signature against a public key built into the binary.
  • No network needed. A key is checked on the core itself, so it works in air-gapped networks.
  • The core only checks keys, it can’t create them.

Activate a key

Open the Billing settings page in the web app as the workspace owner and paste the key. It applies at once. Nothing restarts and nobody gets signed out.

You can also set it in the environment, which is handy when you deploy from code:

export NOKKU_LICENSE_KEY=...
./nokku

Both ways work together. The core never trades a key for one that ends sooner, so an old key in your environment never undoes a renewal made in the web app.

Keep the key in your secret manager like any other credential.

Renew a key

A core that holds a key asks license.nokku.sh once a day for the renewed one. It sends its key and nothing else, and checks the answer like any key before it keeps it. A core without a key never asks.

Set NOKKU_LICENSE_OFFLINE=true if the core should never ask, for example in an air-gapped network. Then activate the renewed key yourself, the same way as the first one.

The core reminds you before it matters. Ahead of the expiry, the web app shows a notice and the core logs a warning.

When a key expires

Nothing breaks and nothing stops.

  • The core keeps running. Sign-in, sessions and everything you already set up keep working.
  • Licensed features turn off until a new key is activated, and limits fall back to those of a core without a key.
  • What you set up keeps holding. Grants still end on time, idle terminals still close, and open access requests can still be denied or cancelled. Only setting up new ones needs a key again.
  • Nothing is deleted right away. Recordings and audit events the lower limits would remove are kept for a grace period. Activate a key in that time and nothing is lost.
  • A KMS works with or without a key. How the core protects its keys is never tied to a license, so an expired one can’t make your data unreadable.

An invalid key never stops the core from starting either. It is ignored and the reason is logged, so check the active license after changing it.

Check the active license

The Billing settings page shows the license and its expiry. The GetLicense call in the API reference returns the same. It’s handy for a smoke test after deploying.