Before you start
This section covers installing Keel and setting it up for a project. Read it in order the first time:
- Install: add the bundle, routes and licence key, then check that it works.
- First configuration with keel:setup: answer a few questions, and Keel writes
config/packages/keel.yaml. - Fine-tune each feature: one page each, from Name, logo and colours to Licence.
Examples has three complete keel.yaml files. The keel.yaml reference lists every option.
What you need
| Pimcore | Pimcore 11 or 12 with the classic admin, or Pimcore Studio (2026+). One bundle works with all of them. |
| PHP | 8.1 or newer, with the sodium extension (it checks signed licence keys) |
| Licence key | Any valid key unlocks all of Keel. More |
| Optional | Pimcore's Generic Data Index (OpenSearch or Elasticsearch) gives faster list search that tolerates typos. More |
Where each setting lives
Keel has settings in several places. A simple rule of thumb:
- keel.yaml holds what the developer decides once per project: folders, the switcher, URLs, classes, limits and the rules for checks. It is in git and the same on every environment.
- Customize (and Data model, Scripts) holds what the client's admin changes over time: which lists show, columns, names, icons, colours, status colours, field labels and tracking scripts. These are stored in the database, per environment.
- Per user (in the database, so it follows them to any browser): language, page size, menu width, favourites.
- Environment: the licence key only.
| Where | Who changes it | What | Stored in |
|---|---|---|---|
config/packages/keel.yaml | Developer | Title, colours, folders, switcher, URLs, classes, list limits, status words, assignments, search, Keel page check rules, languages | Git. A change needs bin/console cache:clear. |
| Customize (Setup → Settings → Customize) | Admins | Lists shown, order, names, icons, groups, columns, statuses, start page cards, theme, assignments per class | Database (Pimcore settings store, scope keel), per environment |
| Setup → Data model | Admins | Field labels, help texts, order, hidden fields | Database, per environment |
| Setup → Settings → Scripts & tracking | Admins | Code added to the website's pages | Database, per environment |
| My view | Each user | Language, dark mode, colours, start page, rows per page, switcher choice, menu, favourites, columns | Database, per user (follows them to any browser) |
| The browser | Each user | Panel widths in editors and previews | The browser only (localStorage) |
| Environment variable | Developer or hosting | KEEL_LICENSE_KEY | .env.local or the server. Never in git. |
When Customize and keel.yaml both set something (colours, status colours, assignments), Customize wins. Reset to automatic in Customize goes back to what keel.yaml says.