Skip to content

Setup

Installing the Tag1 D7ES module

  1. If you haven't yet, sign up for a plan at https://d7es.tag1.com/plans.
  2. Download and enable the latest release of the Tag1 D7ES module from drupal.org, on your target Drupal 7 site.

Configuring the Tag1 D7ES module

  1. Go to the module's configuration page at /admin/config/system/tag1-d7es and enter the billing email address you used when creating your account on https://d7es.tag1.com.
  2. Supply one or more email addresses that should be notified when D7ES security updates are released.
  3. Save the form. Status messages will let you know if the site is authenticated and sending data successfully.

Note: your Drupal 7 site will need to have a properly configured cron job.

Configuring Drush

Requirements:

Set up Drush to use Tag1 D7ES release XML for commands like drush pm-updatestatus by adding or editing your Drush runtime config (drushrc) file.

See Drush documentation where this file should be located.

The following code should be added (or edited, depending on existing configurations):

$release_xml_base_url = RELEASE_XML_PATH;
$command_specific['pm-updatestatus'] = ['source' => $release_xml_base_url];
$command_specific['pm-updatecode'] = ['source' => $release_xml_base_url];
$command_specific['pm-download'] = ['source' => $release_xml_base_url];

Your account-specific RELEASE_XML_PATH can be found on the module’s configuration page /admin/config/system/tag1-d7es, under Advanced after the billing information is entered and validated by the module:

Advanced configuration settings form

How to test

Follow these steps in order to confirm your module's configuration, integration with the Update Status module (if enabled), and optionally the Drush configuration. It uses a testing module tag1_d7es_testing developed on Github in order to simulate a contrib project.

  1. Download tag1_d7es 7.x-1.1-rc1 or later . Enable and configure the module.
  2. Optional: Configure Drush following the instructions above.
  3. Download the packaged 7.x-1.0 version of the testing module from Github and enable it. (If you have Drush configured, you should also be able to drush dl tag1_d7es_testing-7.x-1.0)
  4. Confirm that the message from the testing module is visible at /admin/config/system/tag1-d7es Drupal status message: The Tag1 D7ES Testing module is enabled with version: 7.x-1.0
  5. Confirm that the Update Status report displays an available update for our testing module. Drupal status report showing a security update for tag1_d7es_testing
  6. (Optional) Confirm that drush pm-updatestatus can find the release history for our testing module. Result of drush pm-updatestauts
  7. (Optional) Confirm that drush pm-updatecode can update the project. Result of drush pm-updatecode
  8. Download the update.
  9. Confirm that the message from the testing module is now updated Drupal status message: The Tag1 D7ES Testing module is enabled with version: 7.x-1.1

Web-based Alternative

Requirements: * Drush 8

If you cannot install the tag1_d7es module on your site for business reasons, you can still use Drush and our WebUI tool to securely and anonymously submit your site's status data to us.

Visit the Tag1 D7ES WebUI and enter:

  1. A UUID (Universally Unique Identifier) for your site. This can be randomly generated but must be the same value each time you submit data via the WebUI. Abuse may lead to termination of service.
  2. The billing email address you entered when signing up for Tag1 D7ES.
  3. One or more email addresses to receive email notifications of pending updates.
  4. The output of drush status
  5. The output of drush pm:list

Submit the form and a status message will report if the data has been submitted successfully.

Tag1 D7 ES WebUI

Advanced Setup

Multiple site instances as a single subscription

Tag1 D7ES allows for multiple instances of the same site (development, staging, production, etc.) under a single subscription. In order to support this, each instance that has the module installed must be using the same Site ID.

The Site ID value is a UUID that is generated each time the module is installed, but this value can be overridden under the Advanced section of the module's configuration page /admin/config/system/tag1-d7es.

Tag1 D7ES module configuration page Advanced fieldset

Workflow 1

The module is installed and configured on the production instance. The production database is synced down into lower environments, ensuring the same module configuration that is present in production. This keeps the same UUID for all environments and further action is needed.

Workflow 2

Module configuration may be defined in settings.php, ensuring the same values across all environments.

// The billing email address for your customer account in Stripe.
$conf['tag1_d7es_billing_email'] = '';
// The Site ID, a UUID specific to your site.
$conf['tag1_d7es_site_id'] = '';
// A comma-separated list of email addresses of who should receive security update notifications.
$conf['tag1_d7es_email_addresses'] = '';

For additional flexibility, these values could be set to read from environment variables, rather than being hardcoded.

Workflow 3

The Site ID may be manually synced between environments by editing the Site ID field in the Advanced section of the module's configuration page /admin/config/system/tag1-d7es.