Troubleshooting
The report button is missing
- Reporting can be disabled for users and groups with
options.contextReporter.enable = 0or for everybody with general.enabled. - The tile view of the file list has no action buttons. Switch to the list view or use the context menu of the file or folder.
- If your project sets
options.file_list.primaryActionsitself, addcontextReporterReport, see User TSconfig. - Content elements in the Page module have no report button. Use their ⋮ menu.
- After an update, flush the caches and reload the backend.
The dialog says the object is not available
The dialog only accepts objects that the reporter can access. The message "The selected page, record, file or folder is not available to you." appears when the page, record, file or folder
- is outside the web mounts, file mounts or permissions of the reporter,
- belongs to another workspace than the current workspace of the reporter,
- is file metadata of a file the reporter cannot access, or
- has been deleted in the meantime.
Report the problem from the toolbar instead: the report then refers to the backend view.
Reports do not arrive by email
Open System > Context Reports > Settings > Email and check the
Status panel, see Email status and test email. In most
cases email delivery is switched off, no recipient is saved, or the TYPO3
mail transport is null, mbox, a spool or a local mail catcher such as
Mailpit in DDEV. Use Send test email after every change. The
delivery history of a report shows transport errors without credentials.
Webhook deliveries fail
- Check the Status panel on the Webhook tab and use Send test webhook.
- The endpoint must use HTTPS unless
webhook.allowInsecureHttp is enabled, and must answer
with a
2xxstatus code. Redirects are not followed. - A missing environment variable is shown as such in the status panel.
- The delivery history shows the HTTP status code and the beginning of the response body.
- Slow endpoints fail after webhook.timeout seconds.
A report with a screenshot cannot be sent
- The screenshot is larger than reporting.maxScreenshotSizeKb after compression.
- PHP rejects the request:
upload_max_filesizeandpost_max_sizemust be larger than the screenshot limit. - The database rejects the query:
max_allowed_packetof MariaDB or MySQL must be larger than the screenshot limit, see Storage.
Screen capture is not offered
Screen capture needs a secure context (HTTPS) and a desktop browser with the Screen Capture API. If the browser does not offer it, or the reporter declines the picker, upload an image or paste it from the clipboard.
Copying does not work
Browsers can block clipboard access, especially without HTTPS. TYPO3 then shows "Could not be copied to clipboard". Use Download instead.
The report history shows a database error
The database schema is older than the extension. Run
vendor/bin/typo3 extension:setup or
Admin Tools > Maintenance > Analyze Database Structure, see
Updating the extension.
A setting cannot be changed
Settings that are set in
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['context_reporter'] are
read-only in the module, see Where settings are stored.
If the settings page says that settings of a development version take
precedence, config/ still contains a
context_reporter entry below EXTENSIONS from a pre-release
installation. Remove that entry and configure the extension in
System > Context Reports > Settings.
Old reports are not removed
The default retention keeps reports forever, and the cleanup only runs when
it is started. Configure reporting.retentionDays and
schedule vendor/bin/typo3 context-reporter:cleanup, see
Retention and cleanup.