Enter your license¶
At the end of this page your license key will be in use, and Ferrule will be watching.
During the private beta
Ferrule needs a license key to run. There's no trial yet: without a key in force it watches nothing, sends no alerts, and shows Private beta: not watching above every tab. A key that's withdrawn, or can't be confirmed online for 30 days, stops it the same way. No key yet? Ask for one on the Ferrule Discord.
You can paste a key into the setup wizard, or later on Settings.
Paste the key on Settings¶
- In Ferrule, click Settings ⚙ and open License.
- Paste the whole key into License key. It's one long line starting
FERRULE1. - Click Apply.
The edition changes straight away, with no restart. A key that's wrong or expired is refused, with the reason, and whatever you had before stays in place.
If sign-in is turned on
Only an admin can enter a key.
What the license panel says¶
| Online check | Means |
|---|---|
| Waiting for the first check-in | Normal for a new key. It changes to Confirmed online, usually within two hours |
| Confirmed online | All good. The key is checked again every day |
| Not confirmed online | Ferrule hasn't been able to check the key for a while. The days left are shown; see below |
| Withdrawn | The key has been cancelled. Ask for a new one |
| Offline key: never checks in | A key for a site without internet access |
If it can't check in¶
Once a day (hourly until a new key is confirmed), Ferrule downloads a short
list of cancelled keys from https://license.ferrulehq.dev/revoked. It
sends nothing about you to get it. If it can't reach that address for
30 days, the paid features pause until it can. You'll get a warning a
week before.
After launch, monitoring, alerts and sign-in never stop, whatever happens to a license: only the paid features pause. During the private beta they stop too, as in the box at the top.
For a site that can never reach the internet, ask for an offline key.
Without a key¶
During the private beta, Ferrule watches nothing without a key. After launch:
- Days 1 to 30: the trial, with every feature on. The license panel shows the days left.
- After that: Community, free, with every watching and alerting feature. The paid features are listed on the license panel and in Editions.
Can I put the key in my settings instead?
Yes: set FERRULE_LICENSE with your other settings, in Portainer or in
.env. A key set there always wins, and the box on Settings is locked.