---
title: "Installation"
manual: "Context Reporter"
version: "0.1"
permalink: "https://docs.typo3.org/permalink/priebera/typo3-context-reporter:installation@0.1"
source: "Installation/Index.rst"
rendered: "2026-09-23T13:31:07+00:00"
---

# Installation {#installation}

## Requirements {#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](https://docs.typo3.org/permalink/priebera/typo3-context-reporter:upgrade-typo3@0.1).

## Installation with Composer {#installation-composer}

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

The setup creates three database tables for reports, screenshots and the
delivery history, see [Storage](https://docs.typo3.org/permalink/priebera/typo3-context-reporter:privacy-storage@0.1). The extension also adds its
report action to the default list of primary file list actions, see
[User TSconfig](https://docs.typo3.org/permalink/priebera/typo3-context-reporter:configuration-tsconfig@0.1).

### Classic mode {#installation-classic}

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 {#installation-first-steps}

1.  Open **System > Context Reports** and click
    **Settings** at the top right.
1.  Set a project name and environment, and configure the
    [email](https://docs.typo3.org/permalink/priebera/typo3-context-reporter:configuration-email@0.1) or [webhook](https://docs.typo3.org/permalink/priebera/typo3-context-reporter:configuration-webhook@0.1)
    destination. Check the **Status** panel and use
    **Send test email** or **Send test webhook**.
1.  Switch the destination on, click **Report a problem** in the
    backend toolbar and send a first report.
1.  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](https://docs.typo3.org/permalink/priebera/typo3-context-reporter:usage-retention@0.1). If administrators should not be
able to change the webhook destination, pin it in the system configuration,
see [Webhook: trusted administrators](https://docs.typo3.org/permalink/priebera/typo3-context-reporter:privacy-webhook-boundary@0.1).