Licensing

Install your io.sign licence, check its limits, and know what happens when it expires

A self-hosted io.sign backend needs a licence key from io.finnet. The licence sets its expiry date and the limits of your plan, such as the number of vaults. The backend checks the licence itself, without contacting io.finnet, so it works in an isolated network.

Install the licence

io.finnet sends you the licence key as a single base64 string.

  1. Store the key in your secret manager.
  2. Set the LICENSE_KEY environment variable to the key on every io.sign component, injected from the secret manager.
  3. Deploy, or restart, the components. The backend reads the licence when it starts.
  4. Call GET /v2/license to check it. When the licence is installed, valid is true and readOnlyMode is false.

To renew, update the secret with the new key and redeploy the components.

Check the licence

GET /v2/license returns the licence's state:

FieldDescription
validWhether the licence is valid.
readOnlyModeWhether the backend is rejecting changes. See Read-only mode.
license.customerIdThe customer the licence was issued to.
license.issuedAt, license.expiresAtWhen the licence was issued and when it expires.
license.entitlementsThe limits and features your licence includes.

GET /v2/license/usage shows how much of each limit you use:

FieldDescription
entitlementThe limit, for example VAULTS.
limitYour licence's limit.
currentUsageHow much you use now.
percentagecurrentUsage as a percentage of limit.
exceededWhether you have gone over the limit.

When you reach a limit

A request that would take you past a limit fails with 402 and the error code LICENSE_LIMIT_REACHED. The error's data gives the entitlement, your current usage, and the limit. For example, creating a vault fails once you have as many vaults as your licence allows, and archived vaults still count towards the limit. Contact io.finnet to raise a limit.

Before the licence expires

The backend logs a warning 60, 30, 14, 7, and 1 days before the licence expires. Ask io.finnet for a renewed licence when you see the first warning.

Read-only mode

If the licence is missing, invalid, or expired, the backend runs in read-only mode:

  • You can still read vaults, signers, and requests.
  • Requests that create or change vaults, signers, reshares, or signature requests fail with 403 and the error code LICENSE_READ_ONLY_MODE. No new signatures can be created.

The startup logs say why, with a message such as "License key not found", "Invalid license", or "License expired". Install a valid licence to leave read-only mode.


Did this page help you?