Upgrade 14.1 to 14.2

Overview

This guide describes how to upgrade a Bloomreach Content implementation from version 14.1.x to 14.2.y.

Upgrade Steps

Complete Generic Minor Upgrade Steps

Follow the generic instructions for minor upgrades before proceeding with version-specific changes.

(Optional) Update the Authorization Header

Starting with version 14.2.1, jwt-authentication uses the Authorization header by default. If your implementation already uses the Authorization header for another purpose, configure a different header for jwt-authentication. Refer to Page Model API JWT Authentication for configuration details.

(Optional, Recommended) Remove Camunda for Project Review Management

brXM 14.2 no longer requires Camunda for the Projects feature. Camunda support will be removed in version 15.

If your implementation uses Projects, remove Camunda during the upgrade to 14.2. For instructions, see Use Project without Camunda.

Additional Steps for SPA Projects

In version 14.2, the integration of external SPAs with the Channel Manager is simplified. You no longer need to implement a reverse proxy using URL Rewriters. Instead, configure the preview channel URL with a single JCR property.

Remove URL Rewriter Reverse Proxy Rules

Delete any URL Rewriter rules previously used for reverse proxying the external SPA.

Configure the HST Preview Channel URL

Set the org.hippoecm.hst.configuration.channel.PreviewURLChannelInfo_url property on the channel's hst:channelinfo node to the SPA's URL (for example, http://localhost:3000):

/hst:myproject/hst:configurations/myproject/hst:workspace/hst:channel/hst:channelinfo:
  jcr:primaryType: hst:channelinfo
  org.hippoecm.hst.configuration.channel.PreviewURLChannelInfo_url: http://localhost:3000

For more information, see Configure HST for SPA SDK.

Update SPA Configuration

Modify the BrPage component configuration in your SPA to remove the reverse proxy setup.

14.1 component configuration:

import { BrPage } from '@bloomreach/react-sdk';

const configuration = {
  httpClient: axios,
  options: {
    live: {
      cmsBaseUrl: process.env.REACT_APP_LIVE_BR_BASE_URL,
      spaBaseUrl: process.env.REACT_APP_LIVE_SPA_BASE_URL,
    },
    preview: {
      cmsBaseUrl: process.env.REACT_APP_PREVIEW_BR_BASE_URL,
      spaBaseUrl: process.env.REACT_APP_PREVIEW_SPA_BASE_URL,
    },
  },
  request: {
    path: `${window.location.pathname}${window.location.search}`,
  },
};

const mapping = { Banner, Content };

return <BrPage configuration={configuration} mapping={mapping} />;

14.2 component configuration:

import { BrPage } from '@bloomreach/react-sdk';

const configuration = {
  httpClient: axios,
  cmsBaseUrl: process.env.REACT_APP_CMS_BASE_URL,
  spaBaseUrl: process.env.REACT_APP_SPA_BASE_URL,
  request: {
    path: `${window.location.pathname}${window.location.search}`,
  },
};

const mapping = { Banner, Content };

return <BrPage configuration={configuration} mapping={mapping} />;

Update the environment variables in your SPA's .env file and in any other locations where they are referenced.

14.1 environment variables:

REACT_APP_LIVE_BR_BASE_URL=http://localhost:8080/site
REACT_APP_LIVE_SPA_BASE_URL=
REACT_APP_PREVIEW_BR_BASE_URL=http://localhost:8080/site/_cmsinternal
REACT_APP_PREVIEW_SPA_BASE_URL=/site/_cmsinternal?bloomreach-preview=true

14.2 environment variables:

REACT_APP_CMS_BASE_URL=http://localhost:8080/site
REACT_APP_SPA_BASE_URL=