As an admin, you can integrate EqualGround into TYPO3 and run EqualGround's accessibility, usability, and SEO scanners on your TYPO3 web pages before publishing.
Downloading the EqualGround Plugin
Before integrating EqualGround into TYPO3, you must first download the EqualGround plugin.
- Log in to EqualGround as an admin.
- In the sidebar, select Configuration > Integration Settings.
- From the Select Integration drop-down menu, select CMS Integrations.
- Select the TYPO3 Plugin tab.
- Click Download TYPO3 Plugin.
- Extract the TYPO3 plugin files.
- Navigate to the
equalgroundfolder.
Integrating EqualGround into TYPO3
As an admin, you can use your command line interface (CLI) to integrate EqualGround into TYPO3.
- Open or connect to the CLI where your TYPO3 instance is hosted, such as Terminal.
- Navigate to the root directory of your TYPO3 instance.
-
Run the Composer
version-checkcommand to make sure Composer is installed and working correctly for your TYPO3 instance.composer -v
- Navigate to the TYPO3
packagesdirectory in the TYPO3 root directory. If the directory does not exist, create it. - Copy the
equalgroundfolder you downloaded in step 7 of Downloading the EqualGround Plugin into the TYPO3packagesdirectory:- If your TYPO3 instance is on a remote server, run the
scpcommand to upload theequalgroundfolder.- Specify the source path as the
equalgroundfolder location on your local machine. - Specify the destination path as the TYPO3
packagesdirectory in the TYPO3 root directory.
- Specify the source path as the
- If your TYPO3 instance is on your local server, use any method to copy the
equalgroundfolder into the TYPO3packagesdirectory.
- If your TYPO3 instance is on a remote server, run the
-
Run the
nanocommand to open thecomposer.jsonconfiguration file.nano composer.json
-
In the
composer.jsonconfiguration file, add the text to define the repository:"repositories": [ { "type": "path", "url": packages/equalground", "options": { "symlink": true } } ] -
In the same file, add the text to require the plugin:
Note: Therequireattribute may already exist in thecomposer.jsonconfiguration file. If it does, do not add anotherrequireattribute, add the plugin entry within the existingrequireattribute."require": [ { "yuja/equalground": "1.0.0" } ] -
Run the Composer
requirecommand to install the EqualGround plugin.composer require yuja/equalground-scanner
-
Flush the TYPO3 cache.
./vendor/bin/typo3cms cache:flush
-
Run the Composer
updatecommand to ensure all dependencies are properly installed.composer update yuja/equalground-scanner
-
Flush the TYPO3 cache again to complete the installation.
./vendor/bin/typo3cms cache:flush
-
Run the TYPO3
activatecommand to activate the EqualGround plugin../vendor/bin/typo3cms extension:active equalground_scanner
-
Flush the TYPO3 cache again to apply the changes and ensure the EqualGround plugin is fully activated.
./vendor/bin/typo3cms cache:flush
-
(Optional) Run the TYPO3
listcommand to ensure the EqualGround plugin is installed correctly../vendor/bin/typo3cms extension:list
- Open TYPO3 and log in.
- Select Extensions. The EqualGround plugin will appear in the list with the state set to "stable".
Removing EqualGround from TYPO3
As an admin, you can remove EqualGround from TYPO3 if you no longer need to run EqualGround scanners on your TYPO3 web pages before publishing.
- Open or connect to the command line interface (CLI) where your TYPO3 instance is hosted, such as Terminal.
- Navigate to the root directory of your TYPO3 instance.
-
Run the Composer
removecommand to uninstall the EqualGround plugin. EqualGround will be removed from TYPO3.composer remove yuja/equalground-scanner