Configuration Reference¶
Extension Manager settings¶
Administrators can modify these by going to the Settings module in the TYPO3 backend and clicking on Extension Configuration.
![Finding the Extension Configuration within the Settings module.](../_images/finding-extension-configuration.png)
![The extension configuration options for the Siteimprove extension.](../_images/extension-configuration.png)
The following configuration options are available for the extension.
- Enable Siteimprove for all users with permissions
| Property name: enabledByDefault | Type: boolean | Default: false
When this property is enabled, all users that have the User TSconfig setting options.siteImprove.enable set to 1 or true will see the Siteimprove widget in the page module. Users can disable Siteimprove for themselves by using the setting Disable Siteimprove in the User Settings
- Enable debug mode for Siteimprove integration
| Property name: debugMode | Type: boolean | Default: false
Display debug information for the API connection.
- Siteimprove token
| Property name: token | Type: string | Default: ‘’
The Siteimprove API token. This token is necessary to display the correct analysis information for your site.
The token can be generated at https://my2.siteimprove.com/auth/token
Note
In TYPO3 versions prior to version 9, these settings can be found by clicking the cogwheel icon in the Extension Manager module.
User settings¶
- Every user can access their user settings by clicking their username in TYPO3’s top bar and choosing User Settings from the drop-down menu.
- In the Edit and Advanced functions tab of the User settings, a checkbox allows each user to individually enable or disable the Siteimprove functions.
![Finding Siteimprove in the User Settings](../_images/user-settings.png)
- Enable Siteimprove
| Property name: use_siteimprove | Type: boolean | Default: false
A checkbox to toggle Siteimprove on and off
- Disable Siteimprove
| Property name: disable_siteimprove | Type: boolean | Default: false
A checkbox to disable Siteimprove although you have access to the feature
User TSconfig settings¶
You can also turn on and off the Siteimprove functionality for a single user or a whole user group through User TSconfig settings.
![Disabling Siteimprove for a single user.](../_images/disable-in-tsconfig.png)
- options.siteImprove.disable
| Property name: options.siteImprove.disable | Type: boolean | Default: false
With this setting, you can disable Siteimprove although the editor itself enabled it in the User Settings. This option only works when you have not enabled Siteimprove by default.
- options.siteImprove.enable
| Property name: options.siteImprove.enable | Type: boolean | Default: false
With this setting, you can enable Siteimprove unless the editor itself disabled it in the User Settings. This option only works when you have enabled Siteimprove by default.