Installation
Requirements
| Requirement | Supported |
|---|---|
| TYPO3 | 13.4 LTS and 14.3 |
| PHP | 8.2, 8.3 and 8.4 |
| Required TYPO3 system extensions | typo3/cms-core, typo3/cms-backend, typo3/cms-filelist |
| Optional | typo3/cms-workspaces (workspace titles in reports) |
| Database | Tested with MariaDB 10.11, MySQL 8.0 and SQLite. PostgreSQL has not been tested. |
| Browser | A current desktop browser. Screen capture requires a secure context (HTTPS) and the Screen Capture API; it has been verified in Chromium. Upload and paste work without it. |
The same package works on both TYPO3 branches; Composer picks the matching dependencies. A few labels differ because TYPO3 14 renamed backend modules, see TYPO3 upgrades.
Installation with Composer
composer require priebera/typo3-context-reporter
vendor/bin/typo3 extension:setupThe setup creates three database tables for reports, screenshots and the delivery history, see Storage. The extension also adds its report action to the default list of primary file list actions, see User TSconfig.
Classic mode
Composer mode is the tested and recommended installation method. Classic mode (installation without Composer, through Admin Tools > Extensions) has not been verified yet. If you use it, create the tables with Admin Tools > Maintenance > Analyze Database Structure after the installation.
First steps
- Open System > Context Reports and click Settings at the top right.
- Set a project name and environment, and configure the email or webhook destination. Check the Status panel and use Send test email or Send test webhook.
- Switch the destination on, click Report a problem in the backend toolbar and send a first report.
- Check the delivery in System > Context Reports.
Without a configured destination, reports are stored in the report history and can be downloaded as JSON or Markdown.
Decide early how long reports should be kept: the default retention keeps them forever, see Retention and cleanup. If administrators should not be able to change the webhook destination, pin it in the system configuration, see Webhook: trusted administrators.