Tue May 14 2024 09:22:33 GMT+0000 (Coordinated Universal Time)
Acquia recommends you to follow the instructions on this page only after successfully connecting one or more sites to the Content Hub service. This ensures that the credentials are valid and your sites are able to communicate with the service.
Content Hub follows the module conventions contributed by the Drupal community and stores various module settings in Drupal config entities. These conventions include the following credentials and unique identifiers stored under acquia_contenthub.admin_settings.*:
Credential or identifier | Scope | Description | Config key |
|---|---|---|---|
Content Hub API key and secret key | Environment | The credentials that allow your site to authenticate to the Content Hub service. They are unique for each account that you provision, and remain specific for each environment. |
|
Client UUID | Drupal site | The unique identifier provided by the Content Hub service after registration of a new site or client. It is permanently associated with the site and the Content Hub account, and is used when authenticating to the Content Hub service. |
|
Client name | Drupal site | The unique identifier provided by the Content Hub service after registration of a new client. |
|
Webhook UUID | Drupal site | The unique identifier provided by the Content Hub service after registration of a new client webhook. The absolute URL of the Content Hub client’s webhook is stored in the Content Hub service and referenced with this identifier. |
|
Shared secret | Drupal site | The shared secret value generated by the Content Hub service. It is used to validate incoming webhook requests on a Drupal site. This value is stored in the Content Hub service and must also be stored in the Drupal configuration. |
|
Restrict the Content Hub accounts to one Cloud Platform environment
Your production Content Hub account must contain only clients and entities from production Drupal sites. Content Hub does not enforce or restrict this, but Acquia recommends it as a best practice to avoid confusion and challenges when troubleshooting syndication.
Store the Content Hub API key and secret key in a settings.php include file instead of the database
These credentials are used to authenticate to a specific Content Hub account. If the credentials are stored in the database, and you copy the production database to a lower environment such as staging, the staging environment authenticates to Content Hub as if it is the production site. This can cause content changes made in staging to be syndicated to live production sites. For more information, see Storing sensitive information outside of your codebase.
Export the client UUID, webhook UUID, and shared secret cautiously
These values can be changed by the Content Hub service instead of the Drupal site. For example, Drush can be used to regenerate the shared secret. If the Drupal site becomes out of sync with the values stored in the service, syndication fails. Consider using the config_split contrib module for better control over exporting module configuration.
Scrub the client UUID, webhook UUID, and shared secret stored in the database when staging down databases
Acquia recommends you to run scrub scripts if a database is copied across environments so that the scripts remove the site-specific configuration. If you use Site Factory, see Scrubbing sensitive data from staged sites for informtion about scrub scripts.
After applying the best practices, you can validate that your configuration is set up correctly on each connected site.
To validate connectivity to the Content Hub service, you can use the Drupal admin UI.
The following are the steps to validate connectivity:
Navigate to Administration > Configuration > Acquia Content Hub.
On the Connection tab, verify the following message:
Site successfully connected to Content Hub. To change connection settings, unregister the site first.
You can also expand the collapsed Connection Settings (Your-Account-ID) fieldset, which displays a table containing the following information:
Help
If you can't find what you're looking for, then you can reach out to our Support team for further assistance.