This guide details what the Silktide CMS plugin for Drupal 8 does, how to download and install/configure it, and how it is used in practice. You will need Administrator access and be able to upload a plugin to your Drupal 8 installation.

This plugin enables two main features:

  • Easily switch from the Silktide application to the appropriate page in your Drupal installation to make changes.
  • New or changed pages in your Drupal installation will be automatically checked in Silktide when published.

Downloading/Installing the plugin

This guide should be read in conjunction with the Installing Drupal 8 modules guide on the Drupal site.

Using Composer

If you maintain your Drupal 8 site using composer, just add composer require 'drupal/silktide:^1.1' to your composer.json file and perform ‘composer update’.

Automated module import with URL

Go to the module’s project page at https://www.drupal.org/project/silktide/ and copy the URL for the version of the module you want to use. In your Drupal site, log in as Admin, and go to ‘Extend’. Click the ‘Install new module’ and paste in the URL of the .tar.gz file.

If you do not see the ‘Install new module’ at the top of the ‘Extend’ screen, please ensure you have followed the Drupal guide to Enable the Drupal core module ‘Update Manager’

Manual install

Alternatively, download the tar.gz file from https://www.drupal.org/project/silktide/ (or within Silktide under Settings->CMS) and extract it to [db8-root]/modules/ (where [db-8] is the root of your Drupal 8 website)

Activating the Plugin

After installing the plugin, either click the ‘Enable newly added modules’ button shown or go to the ‘Extend’ page in the Drupal control panel. Tick the box next to ‘Silktide’ and then click either ‘Install’ or ‘Enable’.

Configuring the Plugin

In your Silktide account, go to the Settings -> CMS page and copy the API key displayed.

In your Drupal menu, go to Configuration and select Silktide under the Web Services listing.

In the API Key field of the ‘Silktide Configuration’ page, paste the key you copied in step 1.

Click Save Configuration.

You will need to retest your site in Silktide for these changes to take effect.

Retesting your site

Once the Plugin has been configured in Drupal, you will then need to retest your site so Silktide will read the relevant data.

Login to Silktide and select your report – just click Retest in the top right and wait for the site to retest.

Navigating from Silktide to Drupal

Once the report has finished running, you can then view your results. If everything has been configured correctly, when viewing a ‘Page report’ you should see a pencil icon appear in the top right next to the Page and HTML buttons.

Clicking on the pencil icon will instantly take you to your Drupal installation with the appropriate page loaded.