Skip to content

Personal development environment

The OpenKM personal development environment is distributed as an installer (JAR file) that can be downloaded from the OpenKM Download Center. It supports installation on both Windows and Linux systems.

  • Windows or Linux (dedicated host or virtual machine)
  • 4 GB RAM minimum (8 GB recommended)
  • Java JDK 17 installed

The choice of database is left to the user. The following databases are supported: MariaDB, MySQL, PostgreSQL, and Oracle.

How to get the personal development environment

Section titled “How to get the personal development environment”

You can download the installer from the OpenKM download center.

  • Go to https://download.openkm.com
  • Log in with your customer credentials.
  • In the top menu, choose Tools.
  • On the main page of the Tools section, click on the PorDevInstaller.jar file to download it.

Run the installer with the following command:

Terminal window
$> java -jar PorDevInstaller.jar

The installation wizard will prompt for an application ID and the user’s email address as part of the installation process.

The result is a fully installed OpenKM, configured exactly as a standard OpenKM Professional installation. A service named OpenKM will be registered on the system, both on Windows and Linux.

To activate the license, open a support ticket on the OpenKM customer support website and provide the application ID available on the administration home page.

How to upgrade the development environment

Section titled “How to upgrade the development environment”

The upgrade process is the same as for any standard OpenKM Professional installation. Start the OpenKM service and then run the updater tool from the OpenKM installation folder.

Linux example:

Terminal window
$> sudo su
$> service openkm start
$> cd /opt/openkm/tomcat
$> wget http://download.openkm.com/okm/OKMUpdater.jar
$> java -jar OKMUpdater.jar

Windows example:

Terminal window
C:\> cd C:\openkm\tomcat
C:\openkm\tomcat> java -jar OKMUpdater.jar