Installation and basic configuration

Installation

This module can be installed on any new or existing Drupal 8, Drupal 9 and Drupal 10 website. To download the module and all of its dependencies, call

composer require drupal/siteimprove

Once completed, you can enable the module by either going to /admin/modules and enabling it there, or while already at the console, using Drush:

drush en siteimprove

After that, you can get started with the basic configuration.

Configuration

Configuration of the Siteimprove.ai Plugin.

1. Navigate to the Siteimprove.ai Plugin settings page; /admin/config/system/siteimprove
2. Plugin token:
   - The token is automatically generated and used by Siteimprove.ai to authenticate your subscription.
   - If the Plugin Token field is empty, click the "Request New Token" button and a new token is requested from Siteimprove.ai API.
3. "Use latest experience" allows to switch between the latest and the previous version of the Siteimprove.ai plugin/overlay. The latest version may not support all features in the beginning. The checkbox is by default checked.
4. See Different frontend and backend domains for details about how to configure a separate frontend domain.
5. See Pre-publish content check for details about how to configure and use the pre-publish content check feature.
6. Click on Save Configuration button.

Permissions

Now that we have finished the basic configuration is it time to grant our user roles access the the Siteimprove.ai plugin. The Siteimprove module include the following permisions:

• Administer Siteimprove.ai Plugin [machine name: administer siteimprove]
  Access to configure the Siteimprove.ai module settings.
• Access Siteimprove.ai Plugin [machine name: use siteimprove]
  Access to use the Siteimprove.ai Plugin (overlay). Only users with this permission will see the plugin.
• Use Siteimprove.ai Pre-publish Check [machine name: use siteimprove prepublish]
  Access to use the Siteimprovea.ai Pre-publish content check feature.

Siteimprove.ai Analytics

In order to enable Siteimprove.ai Analytics you need to either add a JavaScript snippet or install a Drupal module that does this, as this is out of scope of the Siteimprove.ai module.

Add JavaScript

Siteimprove.ai's documentation of adding Siteimprove.ai Analytics to any website can be found here: Adding Siteimprove Analytics JavaScript to your website

Basically you need to add the following script tag:

<script async src="https://siteimproveanalytics.com/js/siteanalyze_xxxxx.js"></script>

If you're using Content Security Policy (CSP) you might need to add rules. Refer to Siteimprove.ai's documentation.

Install Drupal module

Instead of manually adding the JavaScript snippet yourself, you can install the Drupal module Siteimprove Analytics. The sole intention for this module is to add Siteimprove.ai Analytics to a Drupal site.