Introduction
This documentation is divided into 2 parts:
- Part 1 describes the actual update of the containers and comes in two options
- Option 1 in case you use our recommended docker compose setup.
- Option 2 in case you have a custom setup. It describes the relevant changes that come with Simplifier 9 in a generic way.
- Part 2 describes steps which have to be done independently of the container orchestration mode.
Part 1: Upgrading Simplifier
Option 1: Upgrade using default docker compose
Step 1 – Shutdown Simplifier Instance
Go to the directory where you placed the docker-compose file. Switch into that folder:
cd docker-compose
To stop Simplifier, run
docker compose down
Step 2 – Get Simplifier setup files
Update the content and switch to the new release branch:
git pull git checkout --track origin/release/LTS
Step 3 Update .env
Make a copy of your .env file
cp .env .env.8.4
Copy the template as new .env
cp .env.template .env
Edit the new .env file
nano .env
It is mandatory that you adjust the first 3 entries to your needs:
# these 3 variables need to be changed SIMPLIFIER_HOSTNAME=example.simplifier.cloud DB_PASSWORD=MySecret123 DB_ROOT_PASSWORD=MySuperSecret
Set these three values to the same ones you used in your previous .env file. DB passwords are not automatically changed if you change it here.
Optional: a list of all env variables with a short description. Change these as needed.
|
SIMPLIFIER_HOSTNAME
|
Simplifier Hostname, FQDN, without protocoll. To access Simplifer, https://${SIMPLIFIER_HOSTNAME} needs to be used |
|
DB_PASSWORD
|
MySQL Database Password |
|
DB_ROOT_PASSWORD
|
Password for the MySQL root user |
|
DB_NAME
|
Database name for the Simplifier database. Used as prefix for all plugin/module databases. |
|
SIMPLIFIER_VERSION
|
Version of Simplifier you want to install. You should not change this. If you want to have another Simplifier version, please check out the appropriate branch instead |
|
HOST_DATA_PATH
|
Path were all data is stored in the host. |
|
PLUGINLIST
|
List of all plugins which should be started. Technically, the Workflow Engine is not a plugin, so it is not mentioned here |
|
SIMPLIFIER_JVM_HEAP_GB
|
How much heap space for Simplier App Server in GB |
|
TZ
|
Timezone. Only used in Workflow Context |
|
WF_RT_JVM_HEAP_GB
|
How much heap space for Workflow Runtime in GB |
|
WF_ARCHIVE_ENABLED
|
For archive-related settings, please refer to this documentation. |
|
WF_ARCHIVE_INTERVAL
|
|
|
WF_ARCHIVE_MAX_AGE_COMPLETED
|
|
|
WF_ARCHIVE_TIME
|
|
|
WF_DT_JVM_HEAP_GB
|
How much heap space for Workflow Designtime in GB |
|
LAUNCHPAD_JVM_HEAP_GB
|
How much heap space for Launchpad in GB |
|
FEATURE_SSBO_JS_DEBUGGING
|
Should the experimental feature “Debugging of Server Side Business Objects” be enabled? (Read more) |
|
DEBUG_CHROME_DEV_TOOLS_EXPOSED_PORT
|
Port used to connect to the debugger. This port needs to be open in your firewall setup. (Read more) |
|
PDFPLUGIN_SECURITY_ALLOW_JAVASCRIPT
|
Should Javascript execution be allowed in PDF templates? (Read more) |
|
DYNAMIC_TAB_TITLES_ENABLED
|
Should the dynamic tab icons and tab titles be activated? (Read more) |
Step 4
Start Simplifier
docker compose up -d
Option 2: Generic upgrade instructions, if you are not using our default docker compose setup
To upgrade to Simplifier 9, shut down Simplifer and change the container image name from
simplifierag/simplifier:8.4 simplifierag/launchpad:8.4 simplifierag/workflow-designtime:8.4 simplifierag/workflow-runtime:8.4
to
simplifierag/simplifier:9 simplifierag/launchpad:9 simplifierag/workflow-designtime:9 simplifierag/workflow-runtime:9
Part 2: Doings after upgrade
Step 1: Update Simplifier Standard Content
Download the latest Standard Content from Marketplace and import it to your Simplifier Instance. Make sure using import scenarios ‘Overwrite all’ or ‘Skip unchanged’ (recommended).
Step 2: Release Notes and Migration Notes
Follow our Release Notes and Migration Notes and implement the necessary changes described there
