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.

Requirements

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.

Depending on your operating system, we recommend reviewing the following documentation sections before proceeding with the installation:

We also recommend reviewing the Database section, which contains useful information on how to create the database and how to configure the openkm.properties file to connect to it.

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.

How to install

Run the installer with the following command:

$> 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.

Make sure that no service named OpenKM is already configured on your system before running the installer.

License activation

The server must have an Internet connection for the license to be activated.

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

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:

$> sudo su

$> service openkm start

$> cd /opt/openkm/tomcat

$> wget http://download.openkm.com/okm/OKMUpdater.jar

$> java -jar OKMUpdater.jar

Windows example:

C:\> cd C:\openkm\tomcat

C:\openkm\tomcat> java -jar OKMUpdater.jar

The installation includes an update.sh script inside the tomcat folder as an alternative to running the updater manually.