Configuring IDE from a clean Eclipse

Caution

We recommend using our OpenKM Portable Development IDE rather than configuring your own.

You can also use IntelliJ IDEA or other Java development tools like NetBeans.

Requirements

Software:

• Eclipse
• OpenJDK 17

Note

Your Eclipse must have support for:

• Maven
• Subversion (recommended)

Hardware:

Suggested minimum hardware configuration:

• 2 CPUs
• 4 GB of RAM ( 8GB recommended )
• 64-bit architecture

Download Eclipse

We suggest downloading the latest stable version of Eclipse. Eclipse comes in several versions. You should download the “Eclipse IDE for Java EE Developers” for your computer architecture (64-bit).

Note

More information at https://eclipse.org/downloads/.

Configure Java

Note

You must have Java installed on your server; otherwise, go to https://learn.microsoft.com/en-us/java/openjdk/download and download the latest OpenJDK 11 version according to your OS and hardware architecture. Execute the Java installer and follow the installation wizard.

Go to Window / Preferences / Java / Installed JRE. You must have OpenJDK 11 defined here:

Configure Tomcat server

Go to the “Servers” tab. Right-click and, from the contextual menu, choose “Add / server”. From the list choose “Tomcat 7 Server”:

Configure a new runtime server environment:

Note

Choose the “Workbench default JRE” if your default JRE is “OpenJDK 11”, or choose “OpenJDK 11” from the list of installed JREs.

Check the box Use Tomcat installation (takes control of Tomcat installation).

Increase the start and stop timeouts (for example, to 180 and 120 seconds, respectively).

Edit the launch configuration: add memory parameters (we suggest 4 GB) and UTF-8 file encoding in the VM arguments field:

-Xms1024m -Xmx4096m -Djava.awt.headless=true -Dfile.encoding=utf-8

Add your OpenKM project in the Source tab:

Add CATALINA_PID to the environment variables:

CATALINA_PID=$CATALINA_HOME/catalina.pid

or

CATALINA_PID=$CATALINA_HOME/catalina.pid

Maven support for Eclipse

The Eclipse version comes with Maven support plugins installed by default.