Updater utility

OpenKM “Updater utility” is a Java Administrator tool that helps with performing upgrades automatically. You can download it from https://download.openkm.com/okm/OKMUpdater.jar.

Caution

Updater utility requires Java 8 >= 8u101

Command line parameters:

Parameter	Description
-h	Show help information.
-d	Update development version ( should only used under OpenKM technicals supervision ).
-f	Force the update.
-l	Remove the Tomcat logs.
-m	Apply actions manually.
-n	Monochrome mode.
-o	Disable post-stage actions.
-r	Disable pre-stage actions.
-u	Override detected Tomcat URL.
-v	Show version.

Upgrade stages

• Check if it’s located at $TOMCAT_HOME folder, otherwise it will raise an error message.
• Ask for some information from the administrator.
  • OpenKM URL (usually someone accessible from server like http://localhost:8080/OpenKM).
  • The application is configured as service [Y/N].
  • The OpenKM valid ROLE_ADMIN user (okmAdmin).
  • The administrator user password.
• Check the service configuration, the user connection and the OpenKM version.
• If the utility is successful on these checks, it will require confirmation by the user to proceed with upgrade [Y/N].
• Download the new OpenKM.war file (current version + 1).
• When finished downloading, it will execute pre-upgrade actions.
• Stop OpenKM.
• Replace the old OpenKM.war file by the new downloaded one.
• Modify the parameter hibernate.hbm2ddl to update into the file $TOMCAT_HOME/OpenKM.cfg.
• Start OpenKM again.
• Check if OpenKM is already available and then execute post-upgrade actions.