Skip to main content
Keel Docs Showcase

Before you start

This section covers installing Keel and setting it up for a project. Read it in order the first time:

  1. Install: add the bundle, routes and licence key, then check that it works.
  2. First configuration with keel:setup: answer a few questions, and Keel writes config/packages/keel.yaml.
  3. 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

PimcorePimcore 11 or 12 with the classic admin, or Pimcore Studio (2026+). One bundle works with all of them.
PHP8.1 or newer, with the sodium extension (it checks signed licence keys)
Licence keyAny valid key unlocks all of Keel. More
OptionalPimcore'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.
WhereWho changes itWhatStored in
config/packages/keel.yamlDeveloperTitle, colours, folders, switcher, URLs, classes, list limits, status words, assignments, search, Keel page check rules, languagesGit. A change needs bin/console cache:clear.
Customize (Setup → Settings → Customize)AdminsLists shown, order, names, icons, groups, columns, statuses, start page cards, theme, assignments per classDatabase (Pimcore settings store, scope keel), per environment
Setup → Data modelAdminsField labels, help texts, order, hidden fieldsDatabase, per environment
Setup → Settings → Scripts & trackingAdminsCode added to the website's pagesDatabase, per environment
My viewEach userLanguage, dark mode, colours, start page, rows per page, switcher choice, menu, favourites, columnsDatabase, per user (follows them to any browser)
The browserEach userPanel widths in editors and previewsThe browser only (localStorage)
Environment variableDeveloper or hostingKEEL_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.