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 working quickly:

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

Requirements

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

Caution

We suggest stopping most applications while running the virtual machine.

We suggest installing on a desktop or a laptop computer, although you can use a laptop with good hardware.

We suggest using an SSD to get extra performance in the virtual machine.

For some users, we have observed that running the virtual machine on a secondary disk provides extra performance; it seems some motherboards do not like the OS and virtualization on the same hard disk.

How to get the personal development environment

You can download the virtual machine file from the OpenKM download center.

• Go to https://download.openkm.com
• Click the button “Download OpenKM Community OVA”.
• Enter your email address.
• Click the “Request” button.

Caution

The download link is sent by email.

The link can be used only once.

You have 24 hours from when the email is sent to use the link; after this time, the link expires.

How to install

The OpenKM personal development environment can be installed on most virtualization software, such as VirtualBox, VMware, or Hyper-V.

Caution

Because OVA (Open Virtual Appliance) is not 100% compatible across virtualization software, VMware users usually need to make a few modifications to the file or extract the VMDK to import the virtual machine.

If you are looking for a quick deployment, we recommend using VirtualBox.

If you decide to use VirtualBox, follow the steps described in the following video https://www.youtube.com/watch?v=9ugBYf5ggu8&feature=emb_logo

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.