README

Object-aware problem reports for the TYPO3 backend.

Editors report a problem where it happens, without looking up page IDs, record UIDs, languages or workspaces. The report automatically carries the TYPO3 context a developer or support team needs: the page, record and content type, file or folder, site, language, workspace and backend module, plus the TYPO3, PHP and browser versions. An optional screenshot is annotated and redacted in the editor's browser.

The screenshot shows what the user sees. The TYPO3 context tells the developer what the problem actually belongs to.

Context Reporter is not a ticket system. Reports are downloaded, emailed or sent to a webhook, so they end up in the tools your team already uses. The local report history is an audit log with an open/resolved marker, not a workflow.

Product website · Documentation · Issues · Security · Support

Features

Report where the problem is: backend toolbar, context menu of pages, records, files and folders, record list, Page module, file list and the record editing form.
Object-aware context: page, record and content type, editing form, file, folder and storage, site, language, workspace, backend module, system and browser. Only allowlisted metadata is collected, and the dialog shows everything before it is sent.
Screenshots, edited locally: screen capture, upload or paste; rectangle, arrow, freehand, text and opaque redaction. Annotations are flattened before upload.
Findings instead of guesswork: the dialog and the report detail group what stands out by website address, placement, visibility, files and permissions. Facts only, no guesses about the rendered page and no verdict on what an editor can edit.
Why isn't it on the website? For pages and records: hidden, start and end dates, frontend user groups, restrictions passed on by parent pages, translation behaviour, hidden or missing translations and the workspace state, and why a page has no website address (no site, page type without view, disabled language, missing translation, workspace).
Where is it placed? The column of a content element and whether the backend layout of the page has it, the backend layout and where it is set, and "Show content from page" in both directions.
Missing images and downloads: file checks list files that are marked as missing, gone from their storage, empty or in an offline storage, of a type the field does not allow, hidden file references and references to files that no longer exist; a reported file lists where it is used. Files and records outside the reporter's access are only counted.
Why can't I edit it? Reports of editors contain their permission facts: table and page permissions, edit locks, language, record and page type, fields that are not available, file permissions.
Frontend problems, too: report a page from the Page or Preview module in the language the editor is looking at; the report links the frontend URL of that language.
Delivery: email through the TYPO3 mail API, a signed webhook (HMAC-SHA256) for n8n, Make, Zapier or your own API, and downloads as JSON or Markdown.
Ready for GitLab and Jira: an importable n8n workflow verifies the signature, creates a GitLab issue and shows its number to the reporter; the documentation covers Jira as well.
Report history: System › Context Reports with filters, open/resolved state, delivery history, manual retry, Copy (summary, Markdown, JSON, link) and Download.
Settings, privacy and retention: configurable reporter identity and browser details, reports kept forever by default or cleaned up after a number of days (also on the command line).
English and German backend labels.

Supported versions

Context Reporter	TYPO3	PHP
0.3	13.4 LTS, 14.3 LTS	8.2, 8.3, 8.4, 8.5
0.2	13.4 LTS, 14.3 LTS	8.2, 8.3, 8.4, 8.5
0.1	13.4 LTS, 14.3 LTS	8.2, 8.3, 8.4, 8.5

Tested with MariaDB 10.11, MySQL 8.0 and SQLite. Composer mode is recommended; classic mode (ZIP from the TYPO3 Extension Repository, installed in the Extension Manager) is supported as well.

Installation

composer require priebera/typo3-context-reporter
vendor/bin/typo3 extension:setup

For classic mode, see Installation: switch off the automatic installation of the Extension Manager before uploading the ZIP, then activate the extension.

Quick start

Open System › Context Reports and click Settings (top right).
Configure email or webhook delivery, check the status panel and send a test email or test webhook.
Click Report a problem in the backend toolbar and send a first report.

Without a destination, reports are stored in the report history and can be downloaded. See the documentation for all settings, the email markers, the webhook protocol with signature verification, storage and retention, permissions and troubleshooting.

To turn reports into GitLab issues, import the n8n workflow and follow the n8n guide, which also covers Jira.

Privacy and security

Collectors read an allowlist of metadata. They do not read record field values (apart from the record label), form contents, cookies, sessions, HTTP headers, credentials or environment variables.
Reports only reference pages, records, files and folders the reporter can access, including file mounts and the current workspace.
Secrets are write-only in the settings, and error messages, ticket references and log entries are sanitized.
Screenshots and reports stay in your TYPO3 database and go only to the destinations you configure.
Administrators are trusted with the webhook destination; the documentation explains how to pin it.

Report security issues privately, see SECURITY.md.

Contributing

Development setup, tests and conventions are described in CONTRIBUTING.md.

License

GPL-2.0-or-later. See LICENSE.txt.

The screenshot editor bundles Konva 10.5.0 (MIT), see Resources/Public/JavaScript/contrib/konva.LICENSE.txt.

priebera / typo3-context-reporter

Package info

Security

Statistics