• Document Up to Date

Release Notes

This section contains release notes for CrafterCMS 3.1.x. For other release notes, please visit your release’s release notes page here: http://docs.craftercms.org

CrafterCMS 3.1.31

Released September 19, 2023

Updates

  • Upgraded various libraries and dependencies


Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.31)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.30

Released May 4, 2023

This release includes fixes for issues with the release version 3.1.29.

Updates

  • Fixed issue with crafter.sh script not terminating Elasticsearch process in RHEL environments
    See here for more information

  • Upgraded various libraries and dependencies

For a full list of tickets, please visit: GitHub 3.1.30 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.30)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.29

Released January 24, 2023

This release includes fixes for issues with the release version 3.1.28.

Updates

  • Fixed issue with upgrade manager (UM) on start-up
    See here for more information

  • Fixed issue on preview pane not refreshing when navigating to other pages from the Sidebar
    See here for more information

For a full list of tickets, please visit: GitHub 3.1.29 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.29)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.28

Released December 21, 2022

This release includes fixes for issues with the release version 3.1.27.

Updates

  • Updated Moment Timezone library
    See here for more information

  • Added support for setting a primary publisher node for clusters
    A node in the cluster needs to be set as a primary publisher before any publishing can happen. To set a node as the primary publishing node, issue the cluster setClusterPrimary API:

    See Studio Clustering for more information

  • Added an environment variable for setting a default esapi library, CRAFTER_ESAPI_DEFAULT_CONFIGURATION
    See here for more information on using the new environment variable

For a full list of tickets, please visit: GitHub 3.1.28 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.27)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.27

Released October 1, 2022

This release includes fixes for issues with the release version 3.1.26.

Updates

  • Fixed issue with editing page URL
    See here for more information

  • Updated Apache Commons dependencies

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.27)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.26

Released September 9, 2022

This release includes fixes for issues with the release version 3.1.25.

Updates

  • Fixed issue with binary content not being removed from ES index

  • Fixed issue with WebDAV indexing docx or xls files

  • Upgraded Tika version to 2.4.0

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.26)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.25

Released August 29, 2022

This release includes fixes for issues with the release version 3.1.24.

Updates

  • Fixed issue in My Recent Activity widget
    See here for more information

  • Increased Audit Report Sites and User drop-down to display all sites and users
    See here for more information

  • Fixed issue with toolbar not refreshing
    See here for more information

  • Fixed error when using TinyMCE v2
    See here for more information

For a full list of tickets, please visit: GitHub 3.1.25 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.25)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.24

Released July 8, 2022

This release includes fixes for issues with the release version 3.1.23.

New Features

Updates

  • Added support for disallowing uploads of SVG files from the image picker
    See here for more information

  • Fixed workflow states not being updated issue
    See here for more information

  • Added support for executing Groovy filters in all types of requests
    See here for more information

  • Fixed issue with Studio and Deployer index.lock
    See here for more information

  • Boosted the internal-name, localId and title fields in search
    See here for more information

  • Improved project creation dialogs
    See here for more information

  • Fixed commits being added as unprocessed on site creation issue
    See here for more information

  • Email notification enhancements
    See here for more information

  • Added check of folder ownership before doing a chown
    See here for more information

  • Fix sort order of Studio search results
    See here for more information

  • Fix site creation failure when session times out
    See here for more information

  • Fix site deletion issue
    See here for more information

  • Fix cache clearing issue with the deployment events watcher
    See here for more information

For a full list of tickets, please visit: GitHub 3.1.24 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.24)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.23

Released April 27, 2022

This release includes fixes for issues with the release version 3.1.22.

Updates

  • Improved search for keywords
    See here for more information

  • Fixed ES queries for binary documents
    See here for more information

  • UI improvements

    • Improved Audit Report User drop down
      See here for more information

    • Added support to unselect/select all children when copying a page or folder
      See here for more information

    • Fixed issue with the delete site button available for site admins
      See here for more information

  • Fixed multipart write content API issue
    See here for more information

For a full list of tickets, please visit: GitHub 3.1.23 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.23)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.22

Released February 23, 2022

This release includes a fix for an issue with the release versions 3.1.19 to 3.1.21.

Updates

  • Corrected SSH related class dependency issue for Crafter Deployer (affects 3.1.19 - 3.1.21)
    See here for more information

For a full list of tickets, please visit: GitHub 3.1.22 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.22)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.21

Released February 7, 2022

This release includes a fix for an issue with the 3.1.20 release.

Updates

  • Fixed S3DeploymentEventsProcessor issues
    The S3DeploymentEventsProcessor now pushes to the correct path.
    Removed adding the sitename automatically at the beginning of all S3 paths the Deployer pushes S3 content to, and instead offer a {siteName} macro that can be used to specify the site name in the S3 path

    See here for more information

  • Fixed issues with text containing - or _ in the content type filename control
    A new text typed in the content type filename control containing a - (dash) or a _ (underscore) is now not removed

    See here for more information

For a full list of tickets, please visit: GitHub 3.1.21 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.21)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.20

Released February 1, 2022

This release includes a fix for an issue with the 3.1.18 release.

Updates

  • Upgraded Elasticsearch version to 6.8.23

  • Fixed indexing issue for a copy of a page
    See here for more information

  • Added support for adding configuration options to the RTE init function
    See here for more information on how to add configuration options to the RTE init function

  • Added support for RTE paste callback hooks
    See here for more information on how to use the RTE callback hooks

For a full list of tickets, please visit: GitHub 3.1.20 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.20)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.18

Released January 19, 2022

New Feature

  • Added support for querying more than one Elasticsearch index in a single query
    See here for more information on how to perform a multi-index query

Updates

  • Fixed the blob store target resolver issue on custom processor
    See here for more information

  • Added management tokens to status checks
    See here for more information

  • Fixed Studio search results when updating the search term while not on the first page of original search results
    See here for more information

  • Fixed issue with request publish option when right clicking on an item in the site tree
    See here for more information

  • Fixed issue with history revert option for items with only the initial commit in history
    See here for more information

  • Fixed dependent documents query issue
    See here for more information

  • Fixed triggering of Preview deploy for clipboard operations
    See here for more information

  • Fixed Solr and Elasticsearch start up
    See here for more information

  • Fixed enforcing of text limits on RTE 2 text fields
    See here for more information

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.18 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.18)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.17.7

Released January 5, 2021

Updates

  • Upgraded Log4j to Log4j 2.17.1

  • Upgraded Tomcat to Tomcat 8.5.73

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.17.7)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.17.6

Released December 19, 2021

Updates

  • Upgraded Elasticsearch to 6.8.22 which in turn upgrades to Log4j 2.17.0

  • Upgraded Solr to a patched 7.7.3 which has been updated to use Log4j 2.17.0

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.17.6)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.17.5

Released December 18, 2021

Updates

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.17.5)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.17.4

Released December 16, 2021

Updates

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.17.4)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.17.3

Released December 15, 2021

Updates

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.17.3)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.17.2

Updates

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.17.2)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.17

Released August 9, 2021

Updates

  • Fixed multi-environment issue with configuration writes
    See here for more information

  • Fixed support for alternative multivalue postfixes e.g. _mvs
    For existing sites the indexes need to be recreated (re-indexing will not fix it if the fields have already been mapped)

    To recreate the indexes in a non-production environment, simply delete the indexes, trigger a normal reindex, and a new one will be created. To trigger a normal reindex, you can follow the process here, starting in Step 2: Invoke the reprocessing.

    For instructions on recreating the indexes in a production environment, follow the steps here see Reindexing Content for Search and Queries

    See here for more information

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.17 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.17)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.16

Released July 12, 2021

Updates

  • Fixed Dashboard issue of an item scheduled for publish stuck in processing
    See here for more information

  • Added property for label form control to render in markup language HTML
    See here for more information

  • Upgraded the embedded MariaDB to version 10.4.20
    For users on macOS, the embedded MariaDb upgrade requires macOS version 10.14 or later

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.16 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.16)

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Before proceeding with updating your CrafterCMS install, please see the following notes:

CrafterCMS 3.1.15

Released June 24, 2021

New Features

  • Added a new deployer API for unlocking a target
    See the Unlock Target API for more information

  • Added access token for Search SEARCH_ACCESS_TOKEN
    Make sure to adjust your Search index management and content management API calls to supply your configured access token

    See Securing Your CrafterCMS Install for more information on replacing the default value for the access token used by Search

Updates

  • Optimized database and git synchronization for a better Crafter Studio experience

  • Script and template sandbox improvements

    • The property crafter.engine.groovy.sandbox.blacklist has been renamed to crafter.engine.groovy.sandbox.blacklist.path

    • Added support for disabling the sandbox blacklist. To disable the sandbox blacklist, set the following:

      CRAFTER_HOME/bin/apache-tomcat/shared/classes/crafter/engine/extension/server-config.properties
      # Indicates if the blacklist should be enabled for all sites (this will have no effect if the sandbox is disabled)
crafter.engine.groovy.sandbox.blacklist.enable=false

    See Script Sandbox Configuration for more information

  • Added support to allow plugins to consume Studio’s theme for creating a consistent look and feel
    See here for more information

  • ETag filter in preview is now disabled by default
    See here for more information

  • RTE bug fixes

    • Fixed content stuck in system processing when special characters are saved
      See here for more information

    • Fixed extra spaces added when inserting a template
      See here for more information

  • Fixed Approve & Publish Timezone offset for Daylight Savings Time
    See here for more information

  • Fixed site creation with git remote failure when repository contains case sensitive files
    See here for more information

  • Fixed dependency calculation when custom extensions for dependencies are configured
    See here for more information

  • Optimized Dashboard backing APIs to enhance filtering speed
    See here for more information

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.15 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.15)

Before proceeding with updating your CrafterCMS install, please see Upgrade Notes for Fixing Template Not Found Error for some important notes

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Please see Upgrade Notes for Fixing Backup Error for some important notes when restoring backups created prior to CrafterCMS 3.1.10, Upgrade Notes for Re-encrypting Values for some important notes on the re-encryption process and Upgrade Notes for Fixing Stored Procedure Error for some important notes on database errors.

CrafterCMS 3.1.14

Released May 3, 2021

New Features

Updates

  • Added support for configurable header names when using Engine header authentication

    When using Engine header authentication, remember to update your SAML2 configuration to use the prefix CRAFTER_, or to update Engine to use your preferred prefix.

    See Engine Headers Based Authentication for more information on configuring header names

  • Optimized Git sync for faster Git log syncing in Studio
    See here for more information

  • Improved error messages that occur on write when system-processing is set to true
    See here for more information

  • Improved dashboard performance
    See here for more information

  • Elasticsearch improvement and bug fix

  • Added support for encrypted properties when using CMIS
    See here for more information

  • RTE improvements

    • Added support for RTE line wrap
      See here for more information

    • Added support for loading external plugins in the RTE
      See Adding External Plugins for more information

  • Upgraded AWS SDK library to 1.11.1000 in various projects

  • Fixed Grab imports failing in the scriptProcessor
    Remember that the grab must contain the following: initClass=false

    @Grapes(
    @Grab(group='com.akamai.edgegrid', module='edgegrid-signer-core', version='4.0.1', initClass=false)
)

    See here for more information

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.14 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.14)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading CrafterCMS

Starting with JVM version 1.8.0_292, support for TLS v1.1 and earlier is disabled by default
See Debugging SSL Handshake Issues if you encounter issues.

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Please see Upgrade Notes for Fixing Backup Error for some important notes when restoring backups created prior to CrafterCMS 3.1.10, Upgrade Notes for Re-encrypting Values for some important notes on the re-encryption process and Upgrade Notes for Fixing Stored Procedure Error for some important notes on database errors.

CrafterCMS 3.1.13

Released February 16, 2021

Updates

  • Updated email notification template format
    See here for more information

  • Improved Studio write processor pipeline
    See here for more information

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.13 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.13)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading CrafterCMS

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Please see Upgrade Notes for Fixing Backup Error for some important notes when restoring backups created prior to CrafterCMS 3.1.10, Upgrade Notes for Re-encrypting Values for some important notes on the re-encryption process and Upgrade Notes for Fixing Stored Procedure Error for some important notes on database errors.

CrafterCMS 3.1.12

Released January 8, 2021

New Features

  • Added a new Deployer processor scriptProcessor that can execute Groovy scripts for processing published content
    See Groovy Script Processor for more information

Updates

  • Added a new option preemptiveAuth in the WebDAV configuration file for enabling/disabling use of preemptive authentication (sending authentication credentials before an unauthorized response)
    See WebDAV Profiles Configuration for more information

  • Improved UI for uploading and browsing files on CMIS
    See here for more information

  • Added support for running scripts at XPath scripts_o/item/key

  • Added an environment variable for use when restoring backups, MARIADB_TCP_TIMEOUT
    This variable is used for setting the wait time for the database to finish starting up during restore. See here for more information

  • Added environment variable used for database connection timeout, MARIADB_SOCKET_TIMEOUT
    See here for more information

  • Bug fixes and performance improvements in auto-clustering Enterprise only feature

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.12 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.12)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading CrafterCMS

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Please see Upgrade Notes for Fixing Backup Error for some important notes when restoring backups created prior to CrafterCMS 3.1.10, Upgrade Notes for Re-encrypting Values for some important notes on the re-encryption process and Upgrade Notes for Fixing Stored Procedure Error for some important notes on database errors.

CrafterCMS 3.1.11

Released November 25, 2020

Updates

  • Added a new property for enabling/disabling support for script tags in Input and Text Area controls
    To enable/disable support for escaping script tags, just put a check or uncheck the property Escape Content in the control’s properties section.

  • Bug fixes and performance improvements in auto-clustering Enterprise only feature

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.11 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.11)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading CrafterCMS

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Please see Upgrade Notes for Fixing Backup Error for some important notes when restoring backups created prior to CrafterCMS 3.1.10, Upgrade Notes for Re-encrypting Values for some important notes on the re-encryption process and Upgrade Notes for Fixing Stored Procedure Error for some important notes on database errors.

CrafterCMS 3.1.10

Released October 9, 2020

Updates

  • Added a new environment variable for the backup folder location
    See Backup and Recovery for more information

  • Elasticsearch improvements

    The ES index settings will be automatically updated when upgrading to CrafterCMS 3.1.10. The automatic update is triggered when upgrading to 3.1.10 because of an update to support custom index settings and update to disable date detection as listed above.

  • Added content-length header for all responses
    The content-length header is sent for all responses by default. If you need to disable sending the content-length header for all responses, just set crafter.engine.header.etag.enable to false

    TOMCAT/shared/classes/crafter/engine/extension/server-config.properties
    # Indicates if the 'etag' header should be added
crafter.engine.header.etag.enable=true

  • Updated dependencies for the following:

    • Upgraded Jackson Databind library to 2.10.5 for various Crafter modules

    • Upgraded ehcache library to 2.10.6 for various Crafter modules

    • Upgraded Apache cxf library to 3.3.5 for Crafter Studio

    • Upgraded xstream library to 1.4.12 for various Crafter modules

    • Upgraded tika library to 1.24 for various Crafter modules

    • Upgraded unit library to 2.0 for various Crafter modules

    • Upgraded commons configuration library to 2.7 for various Crafter modules

    • Upgraded commons text library to 1.8 for various Crafter modules

    • Upgraded groovy library to 3.0.4 for various Crafter modules

    • Upgraded the embedded mariadb4j library to 2.4.8 for various Crafter modules

    • Upgraded node-sass library to 4.13.1

  • RTE improvements
    Browser spell checking is now enabled in TinyMCE 2 and TinyMCE 5

  • Publishing enhancement
    See here for more information

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.10 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.10)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading CrafterCMS

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Please see Upgrade Notes for Fixing Backup Error for some important notes when restoring backups created prior to CrafterCMS 3.1.10, Upgrade Notes for Re-encrypting Values for some important notes on the re-encryption process and Upgrade Notes for Fixing Stored Procedure Error for some important notes on database errors.

CrafterCMS 3.1.9

Released August 20, 2020

New Features

  • Added Git Shell in the Git SSH server image in the CrafterCMS Docker images. This allows an extra level of security since only Git related commands can be used when connecting to the server

Updates

  • Upgraded JGit version to 5.8

  • Published repository improvements
    When creating a site, the published repository is not created until a publish request has been sent. The published repository is initialized when the very first publish request is received.

  • Added support for using the numpad (numeric keypad/ten key/number pad) on a keyboard in number form control

  • Added support for the search API to accept path filters with regex values
    The search parameter (SearchParams) path is now added in the search API for filtering paths using a regular expression. See search for more information.

  • Added a new lifecycle hook for remote targets
    All targets that use the gitPullProcessor need to include a new lifecycle hook, deleteLocalRepoFolderLifecycleHook. This new lifecycle hook will be automatically added to existing targets when upgrading to CrafterCMS 3.1.9 by the upgrade manager.

  • Added support for clearing the site cache for static-assets
    The deployer now includes templates under the static-assets folder in the clear cache post processor. This change will be automatically performed by the upgrade manager for existing targets when upgrading to CrafterCMS 3.1.9.

  • Added new environment variables for encrypting and decrypting values in the database
    See Securing Your CrafterCMS Install for more information on the database values encryption key and salt.

  • Re-encryption of configuration files and remote repository credentials
    This is automatically done by the upgrade manager when upgrading to CrafterCMS 3.1.9. For more information on the re-encryption performed by the upgrade manager, see Upgrade Notes for Re-encrypting Values.

  • Added Studio and Engine support for forwarded headers, to resolve the actual hostname and protocol when it is behind a load balancer, reverse proxy or CloudFront via new properties

    To enable forwarded headers in Engine, open the server-config.properties and set the crafter.engine.forwarded.headers.enabled property to true

    CRAFTER_HOME/bin/apache-tomcat/shared/classes/crafter/engine/extension/server-config.properties
    # Indicates if Forwarded or X-Forwarded headers should be used when resolving the client-originated protocol and
# address. Enable when Engine is behind a reverse proxy or load balancer that sends these
crafter.engine.forwarded.headers.enabled=false

    To enable forwarded headers in Studio, open the studio-config-override.yaml and set the studio.forwarded.headers.enabled property to true

    CRAFTER_HOME/bin/apache-tomcat/shared/classes/crafter/studio/extension/studio-config-override.yaml
    ##################################################
##             Forwarded Headers                ##
##################################################
# Indicates if Forwarded or X-Forwarded headers should be used when resolving the client-originated protocol and
# address. Enable when Studio is behind a reverse proxy or load balancer that sends these
studio.forwarded.headers.enabled: false

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.9 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.9)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading CrafterCMS

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Please see Upgrade Notes for Fixing Backup Error and Upgrade Notes for Re-encrypting Values for some important notes when updating to CrafterCMS 3.1.9

CrafterCMS 3.1.8

Released July 1, 2020

New Features

  • Added a new processor s3DeploymentEventsProcessor that uploads the deployment-events.properties of a site for S3 serverless deployer
    See S3 Deployment Events Processor for more information.

  • Added a new processor, gitUpdateCommitIdProcessor, that only updates the latest commit id
    See Git Update Commit Id Processor for more information.

  • Added a new property updateCommitStore for the gitDiffProcessor that indicates whether or not to update the processed commit
    See Git Diff Processor for more information.

  • Added a new property failDeploymentOnFailure for all processors that enables failing the deployment when there’s a processor failure See Deployer Processors Guide for more information.

  • Added support for automatically updating ES index settings
    Whenever the Elasticsearch index settings are updated, for example, a new field has been added for a release, the ES index settings will be automatically updated by the CrafterCMS upgrade manager. The updated index containing the new settings will be named the current index version name incremented by 1, e.g. let’s say the current index is mysite-authoring_v1, after the upgrade, the new index will now be mysite-authoring_v2

    The ES index settings will be automatically updated when upgrading to CrafterCMS 3.1.8 for users upgrading from CrafterCMS 3.1.6 and earlier, and also for users upgrading from CrafterCMS 3.1.7 where a manual update of the ES index settings has not been performed. The automatic update is triggered when upgrading to 3.1.8 as mentioned above because of an update in the ES index settings (input fields tokenize in repeating groups) in CrafterCMS 3.1.7.

Updates

  • Elasticsearch improvements
    The Elasticsearch client connection timeout, socket timeout and number of threads to use are now configurable for Studio, Engine and Deployer

    • In Studio, go to CRAFTER_HOME/bin/apache-tomcat/shared/classes/crafter/studio/extension/, then edit the studio-config-override.yaml file and update the following properties to the desired values

      CRAFTER_HOME/bin/apache-tomcat/shared/classes/crafter/studio/extension/studio-config-override.yaml
      # The connection timeout in milliseconds, if set to -1 the default will be used
studio.search.timeout.connect: -1
# The socket timeout in milliseconds, if set to -1 the default will be used
studio.search.timeout.socket: -1
# The number of threads to use, if set to -1 the default will be used
studio.search.threads: -1

    • In Engine, go to CRAFTER_HOME/bin/apache-tomcat/shared/classes/crafter/engine/extension, then edit the server-config.properties and update the following properties to the desired values:

      CRAFTER_HOME/bin/apache-tomcat/shared/classes/crafter/engine/extension/server-config.properties
          # The connection timeout in milliseconds, if set to -1 the default will be used
crafter.engine.elasticsearch.timeout.connect=-1
# The socket timeout in milliseconds, if set to -1 the default will be used
crafter.engine.elasticsearch.timeout.socket=-1
# The number of threads to use, if set to -1 the default will be used
crafter.engine.elasticsearch.threads=-1

    • In Deployer, edit CRAFTER_HOME/bin/crafter-deployer/config/base-target.yaml and update the following to the desired values:

      CRAFTER_HOME/bin/crafter-deployer/config/base-target.yaml
      timeout:
  # The connection timeout in milliseconds, if set to -1 the default will be used
  connect: -1
  # The socket timeout in milliseconds, if set to -1 the default will be used
  socket: -1
# The number of threads to use, if set to -1 the default will be used
threads: -1

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.8 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.8)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading CrafterCMS

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Please see Upgrade Notes for Fixing Backup Error for some important notes when updating to CrafterCMS 3.1.8

CrafterCMS 3.1.7

Released June 3, 2020

New Features

  • Added multi-target configuration support for Engine configuration files
    See Engine Multi-Target Configuration for more information.

  • Built-in database security enhancements
    At startup, when Crafter Studio detects an unsecured database, a secure installation script will be run against the database to secure it.

  • Enhanced scripts and templates security
    This addresses the following security advisories: CV-2020080101 and CV-2020080102

    • FreeMarker engine security enhancements with service access limits

    • Groovy engine security enhancements * Groovy engine service access limits * Groovy engine sandboxing

    See Script Sandbox Configuration for more information on Groovy Engine sandboxing and Access to Services for more information on Groovy and Freemarker Engine service access limits.

  • Added support for proxy system to proxy GraphQL, Engine, NodeJS or other application delivery system
    See Proxy Configuration for more information.

  • Added engine API for site status
    See Get Status for more information.

Updates

  • The environment-config.xml configuration has been removed
    The following tags from the environment-config.xml file has been removed and staging and live are now used as defaults for the repository branch name for publishing targets:

    The tags below from “environment-config.xml” no longer exist, “staging” and “live” are now used as default publishing targets
    <open-sidebar />
<publishing-targets>
  <target>
    <repo-branch-name />
    <display-label />
  </target>
</publishing-targets>

    The site URLs from the environment-config.xml file has been moved to Site Configuration
    See Site Configuration for more information.

  • Updated Engine multi-environment configuration
    See Engine Multi-Environment Configuration for more information.

  • Upgraded Deployer Spring Boot library to 2.2.6

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.7 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.7)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading CrafterCMS

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

Please see Upgrade Notes for Fixing Backup Error for some important notes when updating to CrafterCMS 3.1.7

CrafterCMS 3.1.6

Released April 22, 2020

New Features

Updates

  • Upgraded Jackson library to 2.9.10 for various Crafter modules

  • Upgraded Crafter Studio, Engine, Profile and Social Tomcat version to 8.5.53

  • Upgraded Crafter Deployer Tomcat version to 9.0.33

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.6 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.6)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading CrafterCMS

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

CrafterCMS 3.1.5

Released February 21, 2020

New Features

  • Added management tokens for Studio, Engine, Deployer, Search, Profile and Social modules

    Make sure to adjust your monitors to supply your configured token. See Management Tokens for more information.

  • Added API and UI support for encrypting sensitive text in configuration files (like access credentials)

    Make sure to change the default crypto configurations for your deployment

  • Added Deployer support for indexing to multiple ES on a single target

    You can now have multiple Elasticsearch clusters being seeded by a single Deployer target (these clusters can be geo-distributed)

Updates

  • Upgraded Elasticsearch version to 6.8.6

  • Upgraded the following Studio UI dependencies: @types/jest to 24.0.23, @types/node to 12.12.17, @types/react to 16.9.16, graphiql to 0.17.5, typescript tp 3.7.3 and babel-plugin-react-intl to 5.1.11

  • Upgraded Tomcat version to 8.5.51

  • Added support for path style access configuration to all S3 client creations

  • Improved Content type administration UI

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.5 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.5)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading CrafterCMS

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

CrafterCMS 3.1.4

Released November 26, 2019

New Features

  • Added support for CrafterCMS plugins to be listed in Crafter Marketplace simply by tagging your project on GitHub. Follow the instructions here to create your own plugins and list it in the Crafter Marketplace

  • Added support for flattened content XML through a new data source Embedded Content to be used for creating inline components

  • Added a date-time picker inside the targeting dialog in the Website Editorial blueprint

  • Added Publishing Queue tab to Site Config ➜ Publishing

  • Added Code Editor Configuration for adding/editing snippets

  • Added a logrotate sidecar image for docker/kubernetes

Updates

  • Upgraded Jackson library to 2.9.10 for various Crafter modules

  • Upgraded Quartz library to 2.3.2 for various Crafter modules

  • Added support for passing parameters to blueprints during site creation

  • Added support for automatic Engine cache warming and double-buffering in Serverless mode

  • Added support for federated GraphQL and extensible schema definition and overrides

  • Added publishing queue management and improved publishing status reporting

  • Added an RTE plugin for inserting static asset links

  • Improved Create Site dialog

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.4 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.4)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading to CrafterCMS 3.1.3 from 3.1.0 version for instructions on how to upgrade from 3.1.0 to 3.1.3 (applies to 3.1.4)

Please see Upgrade Notes for CrafterCMS 3.1.4 for some important notes when updating to CrafterCMS 3.1.4

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

CrafterCMS 3.1.3

Released September 9, 2019

Updates

  • Fixed bug where field name postfixes were enforced on CrafterCMS reserved fields for older upgraded sites

For a full list of tickets, please visit: GitHub 3.1.3 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.3)

For Docker/Kuber deployments, see Docker/Kuber Instructions for Upgrading to CrafterCMS 3.1.3 from 3.1.0 version for instructions on how to upgrade from 3.1.0 to 3.1.3

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

CrafterCMS 3.1.2

Released September 6, 2019

Updates

  • Fixed bug where field name postfixes were enforced on CrafterCMS reserved fields

For a full list of tickets, please visit: GitHub 3.1.2 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1 (applies to 3.1.2)

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

CrafterCMS 3.1.1

Released August 29, 2019

Updates

  • Upgraded Spring Boot to 2.1.6

  • Upgraded Spring Security to 4.2.13

  • Upgraded Jackson Databind library to 2.9.9.3 for various Crafter modules

  • Embedded MariaDB upgraded to version 10.4.6

  • Upgraded GraphiQL version

  • Upgraded JGit version to v5.4.0.201906121030-r

  • Upgraded jQuery version to 3.4.1

  • Several improvements for GraphQL schema generation, added support for fragments and complex filters in queries and added integration for url transformation service in queries in GraphQL

  • Added message in sites dashboard for users who are not members of any sites

  • Added support UI and API support in Crafter Studio for resolving conflicted repository states

  • Documentation updates

  • Other security related patches

New Features

  • Added plugin support for Form Engine Controls and Data Sources

  • Added deployer target lifecycle hook support

  • Added support UI and API support for Quick Create

  • Added data source for uploading then transcoding video using AWS MediaConvert

  • Added numbers only and time only controls

  • Added Engine API to check if preview is enabled

  • Added support for user controlled publishing of soft and hard dependencies

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.1 Milestone

Important

Please see Upgrading CrafterCMS for instructions on how to update your CrafterCMS install to 3.1.1

For Linux installs, the embedded MariaDB upgrade requires the library libaio which is not installed by default in some Linux distributions. Please see the section on Linux Prerequisites in Linux Prerequisite for instructions on how to install the library libaio

CrafterCMS 3.1.0

Released May 1, 2019

New Features

  • Added Elasticsearch support

    • The default search engine for CrafterCMS is now Elasticsearch (we continue to support Solr)

    • Full support for AWS Elasticsearch as well as vanilla Elasticsearch

    • Improved Studio search with new search backend based on Elasticsearch

  • New Crafter Studio features

    • Added Crafter Studio clustering

    • Added Studio form engine TinyMCE 5 support

    • Added Studio upgrade engine that performs site and blueprint upgrades automatically moving forward

    • Added Video Center Blueprint, a live, live-to-VOD, and video serving site on CrafterCMS.

  • Serverless Delivery

    • Full support for Kubernetes clustering vanilla or AWS EKS

    • Crafter Engine backed by AWS S3 (or compatible services)

    • Added native Docker support. CrafterCMS provided Docker images now available

    • Search is provided by Elasticsearch and is scaled separately

  • Added GraphQL support (Studio and Engine)

  • Added indexing of assets on external storage such as Box, S3, WebDAV, and CMIS

Updates

  • Solr library upgraded to 7.x

  • Improved AWS Media Services integration for video processing (upload, transcode, stream ABR video)

  • Improved S3 datasource integration

  • Improved Crafter Studio user management

  • Improved Crafter Studio/Engine configuration management

    • Support added for a staging waypoint (an environment where you can stage your project before pushing it to production environments)

  • Improved Crafter Studio create site experience

  • Improved code editor for editing code, configuration and textual things (text blocks in forms) in Crafter Studio

  • Improved Crafter Studio external preview support

  • Improved Crafter Studio ICE support

  • Improved logging interface

  • Improved Crafter Studio LDAP/SSO (for new groups)

  • Improved Crafter Studio auditing interface

Lots of other small enhancements and bug fixes :)

For a full list of tickets, please visit: GitHub 3.1.0 Milestone

Important

Please see Instructions for Upgrading to CrafterCMS 3.1.0 from a previous 3.0.x version for instructions on how to update your CrafterCMS install and for some important notes about the update.