Installation
Requirements
| Requirement | Supported |
|---|---|
| TYPO3 | 13.4 LTS and 14.3 or later. TYPO3 14.0 to 14.2 are explicitly declared as conflicting and are not supported. |
| PHP | 8.2 or later ("php": "^8.) |
| Required TYPO3 system extensions | typo3/, typo3/, typo3/,
typo3/, typo3/ |
| Third-party libraries | mpdf/ (PDF export) |
| Optional PHP extension | ext- — required for encrypted remote-access passwords and
per-site AI provider keys |
| Outbound network access | Only for licensed features and Free Remote Preview
(https://). The content scan and the rendered
page check work without internet access. |
Installation with Composer
Install the extension in a Composer-based TYPO3 installation:
composer require priebera/typo3-a11y-quality-gate
Then run the extension setup and flush the caches:
vendor/bin/typo3 extension:setup
vendor/bin/typo3 cache:flush
extension: creates the AQG database tables
(
tx_,
tx_,
tx_,
tx_,
tx_, the
tx_ tables and
tx_) and adds the
tx_ column to
sys_.
See also Installing extensions.
Installation in Classic mode
In a Classic (non-Composer) installation, download the extension from the TYPO3 Extension Repository and install it in the Extension Manager. Run the database analyser afterwards so that the AQG tables are created.
Note
In Classic mode the mpdf/ library must be provided by the
installation. PDF export is unavailable if the library cannot be loaded.
First steps after installation
- Open the Accessibility backend module. On TYPO3 13 it is located below
Web, on TYPO3 14 below Content. The backend route
identifier stays
web_on both versions.a11y - AQG discovers the RTE and file fields it can analyse the first time the
module opens or a scan runs, and writes them to
tx_. The overview confirms how many fields it registered. See Scanned fields.a11y_ field_ config - Review the discovered fields in Settings on the Scan fields tab. Newly discovered fields are enabled by default; disable the ones you do not want to check and press Save changes. Changes take effect only after saving.
- Optional: review the Rules tab and disable rules that do not apply to your project.
- Optional: configure the quality gate on the Publishing rules tab, see Quality gate (publishing).
- Run a first scan, either with Scan site in the module or with the CLI command.
- Optional: activate a licence key, see Licence activation.
Backend user access
The module is registered with access: user, so it is available to
administrators and to backend users whose groups have the module enabled. Grant
access to the module web_ in the backend user group configuration.
All AJAX routes used by the module inherit their access from the same module identifier, so no additional permission configuration is required.
Editors additionally need edit permissions on the records they are asked to fix. The image remediation actions (applying alternative text, marking an image as decorative) additionally require the User TSconfig option described in User TSconfig.