Skip to content

Upgrade instructions versions 2.x versions

2.5.0

Scripts can now accept the hookContextCustomParams parameter

Scripts written prior to this version can now be added/updated to include the hookContextCustomParams as the last parameter to the execute function. This parameter is optional and depends on the web hook implementation to pass along the value(s).

e.g.

function execute(requestPayload, userIdentifier, registrationData, hookContextCustomParams) {
    ...
}

Refer to the scripts documentation for more information.

2.1.0

Environment variables

The following environment variables have changed and will be removed in a future release. Remove them to use the (new) default values.

Old variable name New variable name Old default New default
REST_SERVICES_READ_TIMEOUT_MILLIS RESTSERVICES_READTIMEOUT 30000 10s
REST_SERVICES_CONNECT_TIMEOUT_MILLIS RESTSERVICES_CONNECTTIMEOUT 30000 2500ms

2.0.0

This version contains an upgrade to Spring Boot version 2 and Flyway version 5.

Database

The minimal database versions have changed:

  • Oracle 12.2
  • SQL Server 2014

Older versions of Oracle and SQL Server are no longer supported. The minimal version for MySQL (5.6) remains the same.

Environment variables

Environment variables with a new prefix:

Old variable name starts with New variable name starts with
FLYWAY_ SPRING_FLYWAY_
SECURITY_ SPRING_SECURITY_

Change the following environment variables:

Old variable name New variable name
ENDPOINTS_ENABLED MANAGEMENT_ENDPOINTS_ENABLED_BY_DEFAULT
ENDPOINTS_HEALTH_ENABLED MANAGEMENT_ENDPOINT_HEALTH_ENABLED
EXTENSION_ENGINE_BASIC_AUTHENTICATION_USER SPRING_SECURITY_USER_NAME
EXTENSION_ENGINE_BASIC_AUTHENTICATION_PASSWORD SPRING_SECURITY_USER_PASSWORD
EXTENSION_ENGINE_REDIS_PASSWORD SPRING_REDIS_PASSWORD
EXTENSION_ENGINE_REDIS_SENTINEL_MASTER_ID SPRING_REDIS_SENTINEL_MASTER
EXTENSION_ENGINE_REDIS_SENTINEL_NODES SPRING_REDIS_SENTINEL_NODES

The following environment variables all drop the EXTENSION_ENGINE prefix:

Old variable name New variable name
EXTENSION_ENGINE_DATABASE_TYPE DATABASE_TYPE
EXTENSION_ENGINE_DATABASE_URL DATABASE_URL
EXTENSION_ENGINE_DATABASE_USERNAME DATABASE_USERNAME
EXTENSION_ENGINE_DATABASE_PASSWORD DATABASE_PASSWORD
EXTENSION_ENGINE_DATABASE_ENCRYPTION_PASSWORD DATABASE_ENCRYPTION_PASSWORD
EXTENSION_ENGINE_DATABASE_ENCRYPTION_POOLSIZE DATABASE_ENCRYPTION_POOLSIZE
EXTENSION_ENGINE_DATABASE_MIGRATIONS_ENABLED DATABASE_MIGRATIONS_ENABLED
EXTENSION_ENGINE_PROPERTY_ENCRYPTION_PASSWORD PROPERTY_ENCRYPTION_PASSWORD
EXTENSION_ENGINE_REDIS_DEFAULT_TTL_SECONDS REDIS_DEFAULT_TTL_SECONDS
EXTENSION_ENGINE_REST_SERVICES_READ_TIMEOUT_MILLIS REST_SERVICES_READ_TIMEOUT_MILLIS
EXTENSION_ENGINE_REST_SERVICES_CONNECT_TIMEOUT_MILLIS REST_SERVICES_CONNECT_TIMEOUT_MILLIS
EXTENSION_ENGINE_SECURITY_CLASSES_ALLOWED_TO_USE SECURITY_CLASSES_ALLOWED_TO_USE

Remove the following environment variables:

  • SPRING_DATASOURCE_MAX_WAIT
  • SPRING_DATASOURCE_MAX_ACTIVE
  • SPRING_DATASOURCE_MAX_IDLE
  • SPRING_DATASOURCE_TEST_ON_BORROW
  • SPRING_DATASOURCE_VALIDATION_QUERY