Client Config Care

Protects individual config changes against unintended deployment overwrites on automated config import (e.g. your customers' config on a live site).

INTRODUCTION

The Client Config Care module was introduced to speed up live site deployments by not overwriting configuration changes made by editors with config editing permissions, e.g. changes on blocks or menus.

At publicplan GmbH we are installing this module on our customer websites. This allows our customers' administration privileges, without a problematic deployment process. Because we are not overwriting the configuration changes of our customers. That's the benefit of the Client Config Care module.

GRANULARITY

If a user is editing configuration on a Drupal instance, where Client Config Care is active, a config blocker entity is being created afterwards. CCC won't create any config blocker entities upfront. E.g. user edits a block - config blocker entity for this block is being saved.

The Client Config Care module extends Drupal with functionality for tracking configuration changes made via the administrative interface in the web browser. On live instances these changes are mainly made by clients, meaning users of the websites, such as editors. Website maintainers usually make config changes in their local development environment and export configuration to version it via a version control system such as Git.

Without Client Config Care installed, if your clients made config changes on a live instance, you would get unrelated conflicts if you wanted to deploy configuration from your development environment to the live system.

For example if you are configuring a new module, but the editor has configured blocks and menus, then Client Config Care will have tracked changes on block and menu configuration, which will allow a config import via the Drush command line tool, without overwriting any client configuration.

REQUIREMENTS

This module requires the Config Filter module and PHP at least version 7.1. Client Config Care is meant to be used with Drush for importing configuration to your (live) Drupal instance.

INSTALLATION

Install the Client Config Care module as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for further information.

CONFIGURATION

You can edit your `settings.local.php` for disabling Client Config Care's functionality. Client Config Care will not create any `Config blocker entities` or block config from being overwritten. This setting is recommended on local development environments. Just write the following lines into your `settings.local.php` file to deactivate Client Config Care:

$settings['client_config_care'] = [
  'deactivated' => TRUE,
];

USAGE

Visit `/admin/structure/config_blocker_entity` in your sites backend to get an overview over all config blocker entities and optionally delete any of them. Save any config such as site name at `/admin/config/system/site-information`. If you have not deactivated Client Config Care via the `settings.php` file, you will see a `config blocker entity` in the list at `/admin/structure/config_blocker_entity`.

MAINTAINERS

• Peter Majmesku - https://www.drupal.org/u/peter-majmesku