Skip to main content

Managing your licence

Admin

This page covers the practical steps. For how the licence model behaves — features vs limits, grandfathering, grace periods — see Licensing & entitlements.

Licence administration requires SUPER_ADMIN.

Check your current status

Go to Admin → License. The page shows:

FieldMeaning
TierActive tier, or FREE if no valid licence
Stateactive, grace, or expired
ExpiresExpiry date and days remaining
OrganisationWho the licence was issued to
TrialWhether the current licence is a trial
Instance IDThis deployment's identifier — quote it when requesting a bound licence

A banner appears across the application when a licence is in grace, expired, or absent, so the state is visible without visiting this page.

Start the self-service trial

New deployments can activate a 120-day (4-month) trial of PLAN_2 without contacting anyone. It is self-issued, works offline, and unlocks every feature.

  1. Sign in as SUPER_ADMIN.
  2. Go to Admin → License.
  3. Select Start trial.
One trial per deployment, permanently

The trial can be started once, and the check counts both self-issued and vendor-issued trials — they cannot be stacked. Once used it cannot be reset, reissued, or recovered by reinstalling.

Start it when you are ready to evaluate, not before.

If the option is unavailable, a trial has already been used on this deployment.

Apply a licence key

  1. Sign in as SUPER_ADMIN.
  2. Go to Admin → License.
  3. Paste the licence token and select Apply.

The token is verified locally against a bundled public key. No outbound network access is required, so this works in air-gapped environments.

Applying a licence takes effect immediately — no restart. The action is written to the audit log.

If the licence is bound to a specific deployment, its instance ID must match this one, or it is rejected with binding_mismatch. See instance binding.

Before a licence expires

Expiry does not remove data, but it does restrict what you can change. To avoid surprises:

  1. Note your expiry date from Admin → License.
  2. Check whether you rely on licensed features — particularly multi_tenant. If you run more than one workspace, those workspaces become read-only once the grace period ends.
  3. Renew during the grace period (21 days by default), while entitlements are still fully active.
Multi-tenancy stops at expiry

Grandfathering protects numeric limits, not features. Multi-tenancy is a feature, so tenant workspaces become read-only when it is unlicensed — even if you were using them beforehand. Writes are rejected with TENANT_READ_ONLY; reads continue to work.

Troubleshooting

SymptomLikely causeResolution
TENANT_READ_ONLY on savemulti_tenant not licensedApply a licence including multi-tenancy
binding_mismatchLicence issued for a different deploymentRequest one for this instance ID
Cannot add a userAt your effective limitApply a licence with more seats
Tier shows FREE after applyingToken invalid, expired, or not yet validRe-check the token; verify the server clock
Banner says clock suspectClock moved backwards significantlyCorrect the clock and run NTP
Start trial unavailableTrial already usedTrials are one per deployment

Permissions

ActionPermission
View licence statusAny authenticated user (banner)
View licence detailsSUPER_ADMIN
Apply a licenceSUPER_ADMIN
Start a trialSUPER_ADMIN

API

EndpointMethodDescription
/api/v1/license/statusGETCurrent tier, state, expiry, instance ID
/api/v1/admin/licenseGETFull licence detail (SUPER_ADMIN)
/api/v1/admin/licensePOSTApply a licence token (SUPER_ADMIN)
/api/v1/admin/license/trialPOSTStart the one-time trial (SUPER_ADMIN)

See the API reference for full details.

See also