Keel page check, Site check and Fix it
What it does
Keel 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 them and how scores are made: Keel page check & Site check.
These options set the rules: recommended lengths, the accessibility level, speed limits, and checks to leave out.
Before you switch it on
What admins and developers should know before editors run checks, especially a Site check:
- The browser side is sandboxed. The rendered page runs in a hidden iframe with
sandbox="allow-scripts"and noallow-same-origin: it gets an opaque origin, so its scripts cannot reach Keel, the admin, cookies or the user's login, nor navigate the admin or open popups. Keel itself sends nothing to outside services: the only link that leaves Keel is Open in PageSpeed Insights (pagespeed_link), and only when a user clicks it. The frame inherits the admin's Content Security Policy, so in Pimcore Studio scripts, fonts and frames the page would load from other sites are blocked (and listed as left out). Where the admin sends no such policy, the copy loads what the page itself loads from other sites, as a visitor's browser would. - The page is built on the server by the site's own code, the way a visit builds it (see For template developers
below). Whatever the site's controllers, templates or listeners do on every page view – visit counters, logging,
calls to outside services, writes – also happens once per checked page. Check the client's page code for such side
effects before a Site check runs on all pages. The logged-in admin user (
app.user),$_SESSIONandTool::isFrontend()still come from the admin's own request. - Resources. A Site check is roughly one visitor opening each page (the page plus its own images, CSS and scripts,
loaded from the site), one page at a time per person running it. The checking itself runs in the user's browser: a
few seconds of CPU per page, and up to
page_check.timeout_s(20 s) of waiting for a slow page. Storing a result is one small database write per page (settings_store, scopekeel_pagecheck). Suggest running large Site checks outside peak hours. - Who may run it. Nothing limits who may start a Site check or how often, apart from the page rights
below: every user with view rights on pages can run one.
page_check.enabled: falseis the only switch, and it turns Keel page check off for everyone. - Rights. Running a check needs view on the page (
GET …/check-source). Storing its result – the stored scores, the score history and the Site check – needs save on the page (POST …/check-result, 403 otherwise).
For template developers. The page is rendered on the server the way a visitor's request gets it: frontend mode (no unpublished elements, fallback languages on), a fresh request for the page's own address without cookies, and an empty session of its own. $_COOKIE is empty during the render. Three things still come from the admin's request:
- the logged-in user (
app.user, Pimcore's current admin user); $_SESSION, which is left alone because Symfony's admin session keeps references into it;Tool::isFrontend(), which reads the main request.
So a template that shows something only to logged-in users shows it in the check as well. The page is rendered as a sub-request, so app.request.uri is /_fragment… there. Build og:url and canonical links from the document or app.request.schemeAndHttpHost instead.
Default
Keel page check on, WCAG 2.1-AA, all checks, the limits below.
Options
| Key | Default | What it does |
|---|---|---|
page_check.enabled | true | false hides Keel page check (and with it Site check and Fix it) |
page_check.title.min / .max | 15 / 60 | Recommended page title length, in characters. Shorter or longer gets a warning. |
page_check.description.min / .max | 70 / 160 | Recommended meta description length |
page_check.wcag | 2.1-AA | Accessibility standard: 2.0-A, 2.0-AA, 2.1-AA or 2.2-AA |
page_check.skip | [] | Checks to leave out, by id (list below) |
page_check.vague_link_texts | [] | Link texts that say nothing, added to the built-in ones (click here, read more, više, mehr …) |
page_check.speed.render_ms | warning 800, error 2000 | Time the server takes to build the page, in ms. A time counts only when it is more than 10 % over the limit (see Fixed values). |
page_check.speed.html_kb | 200 | Largest size of the page's HTML, in kB |
page_check.speed.weight_mb | warning 3.0, error 6.0 | Total size of everything the page loads, in MB |
page_check.speed.requests | 80 | Most files a page loads |
page_check.timeout_s | 20 | Seconds a check waits for the page to load (5–120) |
page_check.history | 10 | Results kept per page for the trend (1–100) |
page_check.stale_days | 7 | Days after which a Site check result counts as old (Check pages not checked in 7 days) |
page_check.pagespeed_link | true | Offer Open in PageSpeed Insights for public https pages |
page_check.robots_property | none | The document property that holds noindex. Empty: Keel tries robots, meta_robots, seo_robots, noindex and seo_noindex. |
min must be lower than max, and warning lower than error. Otherwise cache:clear stops with, for example, keel.page_check.title: min (70) must be lower than max (60).
The title and description lengths are also used by the SEO meters in the page settings, the Needs attention filter in Pages and Fix it.
WCAG levels
wcag |
Checks |
|---|---|
2.0-A |
WCAG 2.0, level A |
2.0-AA |
WCAG 2.0, levels A and AA |
2.1-AA |
WCAG 2.0 and 2.1, A and AA. The usual level (the EU accessibility rules ask for it). |
2.2-AA |
Also WCAG 2.2 AA. The newest. |
Check ids for skip
All check ids
| Area | Ids |
|---|---|
| SEO | seo-title, seo-description, seo-h1, seo-headings, seo-img-alt, seo-link-text, seo-noindex, seo-canonical, seo-hreflang, seo-og-image |
| Accessibility | a11y-lang, and any axe-core rule as axe:<rule>, e.g. axe:color-contrast |
| Speed | speed-server, speed-html, speed-weight, speed-requests, speed-oversized-img, speed-lazy, speed-blocking, speed-lcp, speed-cls |
| Good practice | bp-mixed, bp-console, bp-viewport, bp-favicon, bp-blank, bp-deprecated |
An unknown id stops cache:clear and lists the known ones.
What skipping does:
- The check is not run and not scored. Its Fix it is not offered.
- Skipping
seo-titleorseo-descriptionalso removes the length issues from the Needs attention filter in Pages. The SEO length meters in the page settings stay: they are a writing guide. - Results stored by an earlier Site check keep a skipped finding until that page is checked again.
Example
A strict check for a site that sells:
keel:
page_check:
title: { min: 20, max: 55 }
wcag: 2.2-AA
skip: [seo-hreflang, bp-favicon]
vague_link_texts: [mehr erfahren, details]
speed:
weight_mb: { warning: 2.0, error: 4.0 }
render_ms: { warning: 500, error: 1500 }
robots_property: seo_robots
Fixed values
These stay as they are: score penalties (problem 15, warning 6, tip 2; axe critical 15, serious 10, moderate 5, minor 2); LCP 2.5 s / 4 s and CLS 0.1 / 0.25 (Google's numbers); the tolerance on top of the limits, so a page near a limit does not flip from run to run – timings (server render time, LCP) count only when more than 10 % over a limit, a layout shift score only when more than 0.01 over it; CLS is measured from the first paint to 1.5 s after the load event, largest burst of shifts (session window); the Site check trend shows changes of 3 points or more (PageCheckStore::TREND_MIN); an image counts as oversized above 600 px and twice its shown size; the check frame is 1366 × 900. See Fixed in code.
What admins change in Customize
Nothing. The rules are the same for everyone, so they live in keel.yaml.