Setup
- Before you startThis section covers installing Keel and setting it up for a project. Read it in order the first time:
- InstallKeel runs on Pimcore 11 and 12 (classic admin) and Pimcore Studio (2026+). The same bundle serves both. Only the routes file differs.
- First configuration: keel:setupKeel works with no configuration at all: title Dashboard, Keel's colours, one list per class, no switcher. To make it fit the project, run:
- Name, logo & coloursSets the name in the browser tab and header, the logo, the View website button and Keel's colours.
- Content: classes & listsKeel reads your class definitions and gives every data object class a list in the menu. Two keys change that:
- Header switcherThe switcher in the header splits every list, count and search by object folder. Examples: sales markets (UK / DACH), or deal type (Sale / Rent). Pick an…
- Website pages & previewWhen Keel knows the address of an item's page on the website, the editor shows View on website and the live preview. Keel asks, in this order: your own URL…
- Images & uploadsThe picker searches all assets. Editor uploads go to /dashboard-uploads. Files up to 100 MB in Assets and 25 MB in the editor, of 22 common types.
- Lists & big listsSets when a list is paged on the server, how many rows a page shows, and how many columns an automatic list gets.
- StatusesA list with a status field (a select field such as New / In progress / Closed) shows each item's status as a coloured label. It gets status chips to filter by…
- WorkflowsKeel runs Pimcore workflows. There is nothing to switch on: a workflow under pimcore: workflows: shows up in Keel for the classes it supports. Editors use it…
- AssignmentsItems of a list can be assigned to a Pimcore user or role, so everyone sees who works on what. Keel adds an Assigned to column, Unassigned and Assigned to me…
- SearchList search uses Pimcore's Generic Data Index (on OpenSearch or Elasticsearch) when the project has it and it is up to date. Searches then forgive small…
- Keel page checkKeel page check tests one page for SEO, accessibility, speed and good practice. Site check tests all pages, and Fix it helps solve findings. How editors use…
- Interface languagesKeel's menus, buttons and messages come in English, Croatian and German. Content stays in the languages it is written in. These options decide which interface…
- Scripts & trackingAdds code to every page of the website: a tag manager, analytics, chat widgets or verification tags. There is one pair of boxes (In head, End of body) per…
- LicenceKeel 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.
- ExamplesThree complete config/packages/keel.yaml files. Copy the one closest to your project and change the names. Every key is explained in the keel.yaml reference.
- keel.yaml referenceEvery option of config/packages/keel.yaml, under keel:. Everything is optional: a missing key means the default shown here. Copy only what you change.
- Upgradingkeel:install-tables also moves History entries an older Keel kept in Pimcore's settings store into the keel_history tables (bin/console keel:history:migrate…
- Uninstalling KeelUninstalling never happens by itself: nothing in Keel, no update and no cache clear removes what Keel stored. Steps 1 to 5 remove Keel and what it stored…
- TroubleshootingStart with bin/console keel:setup --check. It finds most install problems and prints the fix. Each entry below is: symptom → cause → fix, with the --check…