Examples
Three 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.
Each file is checked with Keel's own configuration rules, so it is valid as it stands. Keel does not check class or field names at cache:clear; keel:setup --check does.
Example values
Class, field, folder, site and address names are illustrative, even where they follow a demo: replace them with yours. Lines marked # example value are made up. keel:setup --check flags names that do not exist in your project.
Real estate agency
Modelled on the Marlin demo (some values are examples): listings in one folder per deal (Sale, Rent), enquiries answered by a team.
- Switcher by deal:
Sale / Rent / All. - Enquiries have assignments, and their status (New, In progress, Closed) gives chips and Open / Closed tabs.
- Names for one item ("+ New Enquiry"), because the class titles are plural.
- Photo folders named after listings, by the listing's code.
- Property statuses Sold and Rented count as closed by themselves; Available and Reserved are taught with
statuses.words.
# config/packages/keel.yaml – a real estate agency (like Marlin)
# Listings live in one folder per deal (Sale, Rent); a team answers enquiries.
keel:
# ── Look ──
title: 'Marlin'
subtitle: 'Real estate'
theme:
accent: '#006B7A' # buttons and links (sea)
accent-hover: '#0A4650'
brand: '#0C1B1C' # active and selected states (ink)
soft: '#F5F2EC' # page background (sand)
line: '#E5E0D6'
# ── Content ──
classes:
exclude: [SearchFilter] # technical class: editors never need it
collections: # one entry per list: here, the name of one item ("+ New Enquiry")
property:
singular: Property
columns: [code, dealType, propertyType, price, status]
location: { singular: Location }
region: { singular: Region }
agent: { singular: Agent }
enquiry:
singular: Enquiry
status_field: status # New, In progress, Closed: chips and Open / Closed tabs
testimonial: { singular: Testimonial }
scope: # header switcher: Sale | Rent | All
label: Deal
options:
Sale: { label: Sale }
Rent: { label: Rent }
paths: ['/Properties/{scope}/']
urls:
Property: '/properties/{slug}' # example value: your site's address pattern
# ── Images ──
image_folder: /photos
upload_folder: /photos/Uploads
folder_labels: # example value: one photo folder per listing, named by its code
'/photos/Properties/{value}': { class: Property, field: code }
# ── Statuses ──
statuses:
words: # the agency's own words, added to the built-in ones
new: [available]
progress: [reserved]
# ── Who works on what ──
assignments:
classes:
Enquiry: { status_field: status, roles: [] }
Tour operator
Modelled on the Wayfare demo (site ids, the extra list and the URL are examples): tours and reviews in one folder per market, each market its own Pimcore site.
- Switcher by market, with an extra value
siteper option. The tour URL uses it as{scope.site}, so View on website opens the right domain. - An extra list Upcoming departures: the Departure class, filtered with a
condition. - Departure statuses: Few seats left is in progress, Sold out counts as closed.
- A strict Keel page check: shorter titles, WCAG 2.2-AA, a lighter page weight, German vague link texts.
- Languages en, hr and de, English until a user picks.
# config/packages/keel.yaml – a tour operator (like Wayfare)
# Tours and reviews live in one folder per market (en, de); each market is its own Pimcore site.
keel:
# ── Look ──
title: 'Wayfare'
subtitle: 'Travel catalogue'
theme:
accent: '#5B5BF7'
brand: '#121A33'
# ── Content ──
scope: # header switcher: UK | DACH | All (a sales market each, not a language)
label: Market
options:
en: { short: UK, label: United Kingdom, locale: en, site: 1 } # site ids: example values; "site" is used as {scope.site}
de: { short: DACH, label: 'Germany, Austria, Switzerland', locale: de, site: 2 }
paths: ['/Tours/{scope}/', '/Reviews/{scope}/']
collections:
tour:
singular: Tour
columns: [code, destination, durationDays, priceFrom]
departure:
singular: Departure
order_by: startDate
order: ASC
upcoming: # example: an extra list of departures that have not started yet
class: Departure
title: Upcoming departures
singular: Departure
condition: 'startDate >= UNIX_TIMESTAMP()'
order_by: startDate
order: ASC
special-offer: { singular: Special offer }
review: { singular: Review }
urls:
Tour:
path: '/{locale}/tours/{slug}' # example value
site: '{scope.site}' # the main domain of the market's Pimcore site
# ── Images ──
image_folder: /photos
upload_folder: /photos/uploads
folder_labels:
'/photos/tours/{value}': { class: Tour, field: code }
# ── Statuses ──
statuses:
words:
progress: [few seats left]
closed: [sold out] # sold-out departures move to the Closed tab
# ── Lists ──
lists:
page_size: 50
# ── Page check: strict, for a site that sells ──
page_check:
title: { min: 20, max: 55 }
wcag: 2.2-AA
speed:
weight_mb: { warning: 2.0, error: 4.0 }
vague_link_texts: [mehr erfahren, details]
# ── Interface ──
languages:
available: [en, hr, de]
default: en
Company website
A plain website: only pages and images, no data object classes. So there are no lists, no switcher and no urls.
- Uploads limited to images and PDF, with smaller sizes. SVG is left out on purpose (it can contain scripts).
- Keel page check without the language-links check (one language) and the favicon check, and Fix it writes noindex into the property the layout reads.
# config/packages/keel.yaml – a plain company website
# Only pages and images: no data object classes, so no lists, switcher or urls.
# Folder names, colours and the robots property are example values.
keel:
# ── Look ──
title: 'Website'
subtitle: 'Pages and images'
theme:
accent: '#0E7490'
brand: '#0F172A'
r: 10px # corner radius
# ── Images & uploads ──
image_folder: /images
upload_folder: /images/uploads
uploads:
max_mb: 20
editor_max_mb: 10
types: [jpg, jpeg, png, webp, avif, gif, pdf] # images and PDF only (no svg)
# ── Page check ──
page_check:
skip: [seo-hreflang, bp-favicon] # one language; the favicon comes from the server
robots_property: seo_robots # the property the layout reads for noindex
After you copy one
- Save it as
config/packages/keel.yaml. - Run
bin/console cache:clear. A mistake stops it with a message that names the key. - Run
bin/console keel:setup --check. It warns about class, field and path names that do not exist in your project.