Personal development environment

OpenKM personal development environment is distributed as a virtual machine image ( OVA ).

The personal development environment comes with everything you need to start quickly working:

• OS Linux Mint distro.
• OpenKM application installed
• MariaDB database
• Eclipse
  • Code samples
  • Workflow samples
• IReport
  • SQL samples
  • Scripting samples

Requirements

The virtual machine uses 2 core and 4GB of RAM, the host machine should have at least 4 core and 8GB of RAM.

Caution

We suggest having almost applications stopped while executing the virtual machine.

We suggest installing on a desktop computer either laptop computer. Although can working in laptop but with good hardware.

We suggest SSD disk to getting an extra performance in the virtual machine.

In some users, we observe executing the virtual machine in a secondary disk provides extra performance, seems some motherboards do not like the OS and Virtualization in the same hard disk.

How to get the personal development environment

Can download the virtual machine file from OpenKM download center.

• Go to https://download.openkm.com
• Click on the button “OpenKM Professional Download Center”.
• Login with your customer credentials.
• In the top menu choose tools.
• In the tools, ensure you have chosen OpenKM version 6.4.x
• Click in the Open KM-PorDev.ova file

Caution

Download link is sent by e-mail.

The link can be used only one time.

You have 24h from the e-mail have been sent to use the link, passed this time the link is expired.

How to install

The OpenKM personal development environment can be installed in almost virtual machine software like Virtual Box, VMWare, Hyper-V.

Caution

Because OVA ( Open Virtual Appliance ) seems is not 100% compatible between virtualization software at least users of VMWare usually should make few modifications in the file or extract the mkv to import the virtual machine.

If you are looking for a quick deploy we encourage using Virtual Box.

If you decide for Virtual Box, follow the steps described in the next video https://www.youtube.com/watch?v=9ugBYf5ggu8&feature=emb_logo

License activation

Danger

Personal development environment must have Internet connection to register the license.

Finally, the license of your personal development environment must be activated, for it follow the next steps:

1- Open a terminal ( the password of the user openkm is openkm)

2- Execute the command

$> pdl-reset

3- Start OpenKM service

$> sudo service openkm start

4- Open an issue in the OpenKM customer support website. Share the application ID available in the home of the administration.

How to upgrade the development environment

The process for upgrading the development environment is exactly the same of upgrading standard OpenKM professional edition. More information at Updater utility.

Troubleshooting

Importing the OVA File into a Non–VirtualBox Virtual Machine

If you encounter issues importing the provided OVA file into a virtual machine platform other than VirtualBox, it is likely due to differences in virtualization formats. Since most VM vendors do not follow a standardized format, direct OVA imports between different platforms are often not supported.

To resolve this issue, follow these steps:

• Rename the OVA file extension from .ova to .tar.
• Extract the contents of the .tar archive using your preferred extraction tool.
• Inside the extracted files, locate the virtual disk image, typically with the extension .vmdk.
• Create a new virtual machine manually in your chosen virtualization platform.
• When prompted for a disk image, attach the extracted .vmdk file as the virtual disk.

This process effectively recreates the original virtual machine using the extracted disk image, making it compatible with non–VirtualBox environments.