Self-hosted licence expiry and renewal
How your server warns before the licence expires, what stops after it lapses, what stays enforced, and how to renew without losing administrator access.
To install the licence for the first time, see Install the licence. This page tells you what your self-hosted CodeHerder server does as its licence runs out. It also tells you how to renew.
Alert on the log line
The server writes a fixed WARN line when the licence is close to expiry. Alert on this text:
license: expiring
The line carries licensee, expiry, days_left and threshold. The server writes it once per UTC day for every day inside the last 30 days. It writes one more line when days_left falls to 14, 7 or 1, so a day can have two lines. threshold is the smallest of 30, 14, 7 and 1 that is at or above days_left.
After expiry, the server writes license: expired once per UTC day, in the grace window and after it. This line carries licensee, expiry, edition, state and grace_ends. When the state changes, the server writes license: state changed with from, to and edition. A state change can add one more expired line that day. Alert on all three lines.
At start, the server writes one of these lines in place of the plain license: resolved line when the licence is close to expiry or past it.
You can also read the days left in three places:
- The Plan & usage card shows “N days left” while the licence is active. In the grace window it shows when the grace ends. It shows a warning when 30 days or fewer remain, and also in the grace window and after the lapse.
ch workspace planprints the same on theLicence:line. An active licence shows the days left, andEXPIRING SOONinside 30 days. A licence in grace shows when the grace ends.GET /v1/workspaces/{id}/planreturnsdaysLeft,graceEndsAtandexpiringSoonin thelicenseblock.
The grace window
An expired licence keeps its edition for 30 days. You cannot change this window. When it ends, the server drops to the community edition. It does this while it runs, so you do not need to restart it.
What stays enforced after the lapse
| Control | After the lapse |
|---|---|
| Sign-in | Stays enforced. |
| Multi-factor authentication | Stays enforced. Your identity provider enforces it. |
| Authorisation and workspace roles | Stay enforced. |
| Audit logging | Stays on. |
| Instance operator access | Stays. An operator can still reach the operator area and renew. |
| Closed sign-up | Stays closed, also after a restart. This holds unless you set CH_SIGNUP_DISABLED yourself. |
What stops after the lapse
| Feature | After the lapse |
|---|---|
| SCIM provisioning | Stops. Your identity provider gets an error. |
| SAML single sign-on | Stops. |
| New webhooks | Stop, unless the workspace’s own plan includes them. |
| New personal API keys for people | Stop, unless the workspace’s own plan includes them. Agent keys are not affected. |
| Release downloads from this server | Stop. |
| Licence limits | Stop. Each workspace uses its own plan limits, which are low by default. |
Before you rely on it
- Keep one operator who signs in without SAML. That operator can still renew after a lapse.
- Leave
CH_PLAN_ENFORCE_HISTORY_RETENTIONunset. When it is set, each workspace keeps only the history its own plan allows. The lowest plan allows 7 days.
Renew the licence
- Get the new licence file from the support contact.
- Replace the file that
CH_LICENSE_FILEpoints to. If you setCH_LICENSE, replace that value. - Restart the server. The server reads the licence at start only.
- Run
ch workspace plan. ConfirmEdition: enterpriseand anactivestate on theLicence:line.
A lapsed server returns to the enterprise edition as soon as it starts with the new file.
Last updated