Docs Account, plans & billing
Account, plans & billing
Licences and installations
Connect each self-hosted installation to your Kumo.io account, then give it a licence from your account's licence pool. You manage both in your Kumo.io account at account.kumo.io.
How licensing works
- Your Kumo.io account holds a pool of licences. Each licence you buy adds one to the pool.
- Each installation (a Kumo.io instance you run) connects to your account and checks in with it regularly.
- You assign a licence from the pool to an installation. An installation with a licence runs that licence's plan. You can release it and give it to another installation at any time.
Until you have licences, connected installations run on your account's 14-day evaluation. See What happens during and after my trial?
Already have a licence from Kumo.io? You can install it directly on your deployment with the KUMO_LICENSE_* settings, without connecting to an account.
Connect an installation
- On your Kumo.io instance, choose Connect account and follow it to your Kumo.io account at https://account.kumo.io.
- Log in, or sign up. You come straight back to Connect this Kumo.io instance.
- If you belong to more than one account, choose Which account should own this instance?
- Check the details (name, version, distribution, architecture and account), optionally change the Instance name, and choose Connect instance.
- When you see Kumo.io is connected, return to your instance: it continues automatically. Continue to your installations opens your list.
If the request has timed out, the page says This connection request expired. Go back to your instance and choose Connect account again.
See your installations
Installations in your Kumo.io account lists every connected instance with its name, status, version, distribution, architecture, last check-in and plan. You can search by name and filter by status.
| Status | Meaning |
|---|---|
| active | Checking in normally. A new installation shows "Never checked in yet" until its first check-in. |
| stale | Has not checked in recently. It keeps working with its current entitlement. |
| suspended | Suspended by Kumo.io. Contact support. |
| deactivated | No longer receives renewed entitlements. |
The Plan column shows the plan of the licence an installation holds, or Evaluation if it has none.
Assign or release a licence
Open an installation from Installations.
- To assign: if the installation is not holding a licence and your pool has a free one, choose a Plan and Assign license.
- To release: choose Release license back to the pool. The licence becomes free to assign elsewhere. On its next check-in, the released installation falls back to your account's evaluation, or locks after its grace period if the evaluation has ended.
If no licence is free, the page says "No free license — add licenses or release one from another installation."
Buy or add licences
Open Billing in your Kumo.io account.
- With no subscription, choose a Buy button. Each purchase is one licence.
- With a subscription, change the number in Licenses and choose Update. You can't go below the number of licences already assigned: release them first.
See How do I pay, change plan or get invoices?
On the installation itself, Billing & Plan shows the licence it holds and until when it is valid.
Rename an installation
Open the installation, change Display name under Rename and choose Save name.
Deactivate an installation
Deactivate an installation you no longer use. It stops receiving renewed entitlements. Its local data is not deleted, and it keeps the features its current entitlement allows until that entitlement and its grace period run out.
- Open the installation.
- Under Deactivate installation, type the installation's name exactly in Type the installation name to confirm.
- Choose Deactivate installation.
If you logged in more than 15 minutes ago, Kumo.io asks you to log in again first.