Upgrade HST Configuration

In version 13, HST is also used in the CMS/platform web application. For that, parts of your project's HST configuration need to be upgraded.

Specify CMS Mounts in Platform Configuration

In order to make the Channel Manager functionality of the CMS work, you must define a CMS mount (HST configuration) in the CMS/platform web application. See section "Hosts configuration in the platform web application" on the Hosts Configuration page. Adjust the sample YAML code provided there for your project, making sure that all Virtual Host Groups of your project have a corresponding CMS mount defined.

Note that this piece of HST configuration must be specified in an artifact packaged with the CMS/platform web application, typically in the myproject-repository-data-application artifact.

Specify host info the CMS hosts

Like for regular HST site mounts, you need to configure the following properties on the CMS mounts:

  • hst:scheme (default http if missing)
  • hst:showcontextpath (default true if missing)
  • hst:showport (default true if missing)

If the CMS mount is accessed over https, make sure to set hst:scheme = https. If the CMS URL does not have the contextpath or portnumber in it, make sure to set hst:showcontextpath and hst:showport to false.

Remove Deprecated HST Configuration Properties

Due to the explicit CMS mount configuration described above, a few old HST configuration properties are now obsolete and must be removed from your project's YAML sources and repositories. If the affacted nodes are categorized as config, updating the YAML definitions is sufficient; the updates will trigger the removal of the obsolete properties when the changed YAML sources are deployed. If the affected nodes are categorized as content, e.g. if your project allows creating new channels at run-time, changing the YAML sources will not affect the repository properties, and these properties must be cleaned up manually. The following properties should be removed:

  • hst:defaultcontextpath (on nodes of type hst:virtualhosts)
  • hst:cmslocation (on nodes of type hst:virtualhostgroup)
  • hst:contextpath (on nodes of type hst:virtualhost, hst:mount and hst:blueprint)
  • hst:onlyforcontextpath (on nodes of type hst:virtualhost and hst:mount)

Specify Site Configuration Root Path

As of version 13.0.0, every site web application must specify the root path for its HST configuration in its hst-config.properties file. If you fail to specify this root path, the site web application will not be able to load its own HST Model. Instead, it will load the default model below hst:platform.

When upgrading, you must specify the hst.configuration.rootPath property in site/webapp/src/main/webapp/WEB-INF/hst-config.properties (or at a custom location, see HST Container Configuration). Since you upgrade to Single Site Mode, you must set the value to /hst:hst.

hst.configuration.rootPath = /hst:hst

Move setting for page copy across channels to the CMS 

If you have enabled page copy across channels in the site's hst-config.properties, that setting is to be moved the HST platform, i.e. to the CMS war. 

Upgrade HST Configuration for Replication and/or Synchronization Add-On

This step is only applicable if you use the Replication Add-on and/or the Synchronization Add-On.

Prior to version 13, HST configuration below /hst:hst is replicated by default. As of version 13, only HST configuration below /hst:platform is replicated by default. If you want HST configuration below /hst:hst to be replicated as well, you must add /hst:hst to the property /hippo:configuration/hippo:modules/replication/hippo:moduleconfig/metadata@includedpaths (see also Configuring Replication).

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?