Gentics CMS-OSS Documentation

Chapters

1. Migrate configuration

   • Transform to .yml file(s)

   • Manual transformation of configuration settings

   • Configuration changes

   • Keycloak Integration

   • Property substitution

   • Environment variables

   • Disk based cache files

2. Changes in directory structure

3. URL Changes

4. File Upload Manipulator

5. Removed Features

   • XNL

   • Import/Export

   • SSO with CAS

   • Activiti Integration

   • Auto-Update

1 Migrate configuration

When starting CMS 6.0 it is important to define which configuration files to load via a comma separated list in either

• Environment variable `CONF_FILES`, or
• Java system property `com.gentics.contentnode.config.files`

Note that for every directory in this list, all .yml files in the directory will be loaded.

1.1 Transform to .yml file(s)

The format of the configuration files has been changed from PHP files to YML files.

To help with the migration, there is a tool in the CMS (also available in CMP 7.x), which converts the current configuration into a YML file. The tool must be used in a CMS running CMP 7.x:

/Node/bin/java.sh com.gentics.contentnode.tools.MigrateConfiguration -config "http://localhost/.Node/?do=24" -out /tmp/new_configuration.yml

It supports the following command line parameters:

1.2 Manual transformation of configuration settings

1.2.1 Enabling of features

In the old PHP-style configuration, features were enabled like this:

$FEATURE["wastebin"] = true;

In the new format, this is done with:

feature:
  wastebin: true

1.2.2 Database Access

PHP-style:

$SETTINGS["db"] = "<dbname>";
$SETTINGS["server"] = "<dbhost>:<dbport>";
$SETTINGS["login"] = "<dbuser>";
$SETTINGS["pw"] = "<dbpassword>";

New format and configuration parameters:

db:
  settings:
    url: jdbc:mariadb://<dbhost>:<dbport>/<dbname>
    user: <dbuser>
    password: <dbpassword>

1.2.3 Other settings

Most other settings will be transformed in the following way:

PHP-style:

$ALOHA_SETTINGS['plugins']['block']['rootTags'] = array('div', 'span', 'a');

New format:

aloha_settings:
  plugins:
    block:
      rootTags:
        - "div"
        - "span"
        - "a"

1.2.3.1 Exceptions

There are two exception to the naming rule above:

1. Settings in `$PUBLISH_LOAD_BALANCING` must be put under `config.loadbalancing`.
2. Settings in `$VELOCITY_PROPERTIES` must be put under `velocity`.

PHP-style:

$PUBLISH_LOAD_BALANCING["threadlimit"] = 2;

$VELOCITY_PROPERTIES["resource.loader"] = "string,file";

New format:

config
  loadbalancing:
    threadlimit: 2

velocity:
  resource.loader: "string,file"

1.3 Configuration changes

Some configuration parameters have been renamed or removed:

1.4 Keycloak Integration

Keycloak integration is now done in the following steps

1. Activate Feature
2. Place keycloak.json as ui-conf/keycloak.json
3. Optionally configure keycloak.user_created_callback
4. Optionally configure keycloak.init_groups

feature:
  keycloak: true
keycloak:
  user_created_callback: your.companyname.custom.SsoUserCreated
  init_groups: |
    if(attr.roles.realm CONTAINSONEOF 'admin-user-role',
      [3],
      if(attr.roles.resource.gcms CONTAINSONEOF 'editor-user-role',
        [4],
        [5]
      )
    )

1.5 Property substitution

The new configuration files will now support property substitution in string values.

The general format for property substitution is ${key:property} where key defines substitution type, and property the property to be substituted:

1.6 Environment variables

The CMS now supports the following environment variables (some settings can also be set over Java System properties or in the CMS configuration):

1.6.1 HTTP_PORT

1.6.2 CONF_PATH

1.6.3 DBFILES_PATH

1.6.4 CONF_FILES

1.6.5 LICENSEKEY

1.6.6 KEYS_PATH

1.6.7 CACHE_CONFIG_PATH

1.6.8 CACHE_PATH

1.6.9 LOGS_PATH

1.6.10 PUBLISH_PATH

1.6.11 GIS_PATH

1.6.12 PACKAGES_PATH

1.6.13 CONTENT_PACKAGES_PATH

1.6.14 SCHEDULER_COMNANDS_PATH

1.6.15 STATIC_SERVE_LIST

1.6.16 UI_CONF_PATH

1.6.17 TMP_PATH

1.6.18 NODE_USER_PASSWORD

1.6.19 NODE_DB_DRIVER_CLASS

1.6.20 NODE_DB_HOST

1.6.21 NODE_DB_PORT

1.6.22 NODE_DB_USER

1.6.23 NODE_DB_PASSWORD

1.6.24 NODE_DB_NAME

1.6.25 NODE_DB_PARAMETERS

1.6.26 NODE_DB_URL

1.6.27 NODE_DB_INIT_TIMEOUT

1.6.28 ALOHAEDITOR_PATH

1.6.29 ALOHAEDITOR_PLUGINS_PATH

1.6.30 GCNJSAPI_PATH

1.7 Disk based cache files

In order to have the cache place the files for disk based caches (normally for GIS and publish cache) at the configured location, it is mandatory to have the cache.ccf file contain the following lines:

...
jcs.auxiliary.DC.attributes.DiskPath=${com.gentics.contentnode.cache.path}
...
jcs.auxiliary.PUB.attributes.DiskPath=${com.gentics.contentnode.cache.path}
...

2 Changes in directory structure

The directory structure has been flattened and made configurable. The new default values are considered relative to the execution directory of the CMS. If the CMS is running in a container, this will be relative to /cms.

3 URL Changes

The URLs to various parts of the CMS have been changed (shortened), and some parts have been removed:

4 File Upload Manipulator

Since PHP has been removed from the CMS, it is no longer possible to implement a File Upload Manipulator with PHP scripts that run along with the CMS. Existing PHP scripts that serve as File Upload Manipulator must be migrated to an external service, which can run PHP scripts.

When the container image of the CMS is used, that external service must run in another container and http access between the CMS container and the FUM container must be possible.

5 Removed Features

5.1 XNL

Rendering XNL has been removed. All existing XNL Implementations must be replaced with Velocity Implementations.

5.2 Import/Export

Use the new Content Staging. instead.

5.3 SSO with CAS

Single-Sign-On is now handled by the Keycloak integration

5.4 Activiti Integration

Use the Activiti API directly.

5.5 Auto-Update

See the Gentics infoportal for instructions on how to update Docker, Kubernetes or Linux installations.