Skip to main content
Keel Docs Showcase

Licence

What it does

Keel needs a licence key. Any valid key unlocks all of Keel: every feature in this documentation. There is nothing to switch on in code or keel.yaml.

Keys issued for the former Keel Pro or Keel editions both keep working and unlock everything.

The key

Environment variableDefaultWhat it does
KEEL_LICENSE_KEYnoneThe licence key. Set it in .env.local or as a server variable. Never commit it.
dotenv
KEEL_LICENSE_KEY=KEEL1.…
  • Keys start with KEEL1. and are signed: they carry the customer's name and, if the key ends, its last day. Keel checks them on the server itself, without contacting anyone. The PHP extension sodium is needed for that.
  • Keys that do not start with KEEL1. are no longer accepted. Ask for a signed key.
  • Without a valid key the Keel tab opens with License required, and nothing else works.

Is the key working? On the server, run bin/console keel:setup --check. The licence line shows the customer, e.g. ✔ Licensed to Example Ltd, or the exact problem.

After changing the key, run bin/console cache:clear if the environment variables are cached (for example with composer dump-env).

When a key expires

A key can carry an end date: its last valid day, in UTC. A key without one never ends.

WhenWhat happenskeel:setup --check
Until 30 days before the dateEverything works✔ Licensed to Example Ltd · valid until 2027-03-31
The last 30 daysEverything works! Licensed to Example Ltd: expires on 2027-03-31 (12 days left)
14 days of grace after the dateEverything still works. Admins see a warning at the top of Keel.! Licensed to Example Ltd: expired on 2027-03-31, Keel locks after 2027-04-14 (5 days left)
After the graceKeel is locked✖ The licence expired on 2027-03-31 and its 14 days of grace are over: Keel is locked, the website keeps running · licensed to Example Ltd

Only the ✖ line makes --check end with exit code 1.

The warning during grace reads: The Keel license expired on 2027-03-31. Keel locks after 2027-04-14 unless a renewed key is added; the website is not affected.

When Keel is locked

  • The Keel tab opens with License expired: Your Keel license has ended, so Keel is locked. Your content is safe and the website keeps running. Add a renewed key to KEEL_LICENSE_KEY and reload the admin.
  • Every request to Keel, also to a project's subclass of a Keel controller, answers 403 with Keel license expired. Add a renewed key to KEEL_LICENSE_KEY in the environment.
  • The public website is not affected. The check covers Keel's controllers only, so a locked Keel keeps adding the scripts from Setup → Settings → Scripts & tracking to the website's pages. They just cannot be changed in Keel until it is unlocked.
  • Nothing is removed: content, Customize settings and My view stay as they are, and Pimcore's own admin keeps working.

To unlock Keel, put the renewed key in KEEL_LICENSE_KEY, run bin/console cache:clear if the environment variables are cached, and reload the admin.