Update CMS Configuration

Overview

This page describes how to update project-specific CMS configuration in a specific server environment, such as production.

When to Use

Update CMS configuration when your project requires changes to settings or plugins beyond the defaults provided by Bloomreach Content or its plugins. Apply this process during new releases that introduce modified or additional configuration.

Stakeholders

Developer

Prerequisites

All project-specific CMS configuration must be stored and version-controlled in the project's repository-data/application module.

CMS Configuration Structure

Bloomreach Content stores configuration under /hippo:configuration in the repository. This area contains settings for the CMS application and any installed plugins. By default, these nodes are created by the CMS application or plugins and are updated only when you upgrade Bloomreach Content or its plugins.

Project-specific requirements may require you to modify or add configuration nodes under /hippo:configuration. When you deploy a new release that changes these settings, you must update the CMS configuration in the target environment.

Procedure: Update CMS Configuration Nodes

Use the Automatic Export feature to manage changes to CMS configuration nodes. Automatic Export exports changes as YAML files in your repository-data/application module.

Follow these steps:

Enable the Automatic Export feature in your development environment. This ensures that any changes to CMS configuration are exported as YAML sources in the repository-data/application module.
Before making changes, confirm that the nodes you plan to modify have not been changed directly in the target environment.
Modify the required CMS configuration nodes in your development environment. Automatic Export will generate the corresponding YAML files in your project.
Review the exported YAML files in repository-data/application and commit them to your version control system.
Package the repository-data/application module with your release artifacts.
Deploy the release artifacts to the target environment. Ensure that bootstrapping is enabled. The system will automatically apply the configuration changes when the new release starts.

If you encounter a scenario that Automatic Export cannot handle, write and execute a custom Updater Script. Bootstrap the script to the updater registry and execute it manually after the new release starts.

Summary

By default, CMS configuration is added to the repository by the CMS application or plugins.
Project implementations can update CMS configuration nodes using YAML sources.
Automatic Export covers most use cases by exporting configuration changes as YAML files in repository-data/application.
Use an Updater Script only for scenarios that cannot be handled by Automatic Export.