MidPoint 3.7 and later
This guide applies to midPoint 4.0 and later. For guides that apply to older releases please see the release notes.
Source Code
This guide provides instruction for installing midPoint from the source code. It requires software development tools and some experience to build the product. This is recommended only for engineers that want to participate in midPoint development or have deeper interest in the source code. Everybody else will probably find installing binary release much easier.
Before You Start
Release Notes
Please make sure to see Release Notes for list of environments that are known to work and for the list of known issues in current release.
Prerequisites
Java Development Kit 11
The development environment requires at least JDK 11. OpenJDK is recommended and it might be already installed on your system.
JAVA_HOME
environment variable should point to the JDK installation path.
Java 11
MidPoint 4.0 and later are supported on Java 11 platform. MidPoint supported Java 8 in the past and midPoint 4.0 can still run on Java 8. However, Java 8 support is deprecated and it will be removed soon. Please switch to Java 11 as soon as possible.
Git
The midPoint source is available from a Git server. The details regarding Git, Git client software and Git server locations are described in Git page. Short summary of Git coordinates is provided in the following table.
GitHub project page | https://github.com/Evolveum/midpoint |
---|---|
Git Repository URLs (public access) | https://github.com/Evolveum/midpoint.git git@github.com:Evolveum/midpoint.git |
Maven
Download and install Maven3: http://maven.apache.org/download.html
M2_HOME
environment variable should point to the Maven installation path.
Prepare MidPoint Software
Get MidPoint
On Windows we highly recommend to add the following switch to the git clone command: --config core.autocrlf=false
Actually, you can use the switch on any platform. While in theory autocrlf works, it does not work well for midPoint projects. Don't forget to adjust project settings for IDE accordingly (taken care of automatically when using IntelliJ IDEA).
Get the source from our Git repository:
git clone -b v4.0 https://github.com/Evolveum/midpoint.git
Please use appropriate tag (e.g v4.0
) for current release. To check out the latest development (master) branch skip the -b flag entirely:
git clone https://github.com/Evolveum/midpoint.git
For more information about the source repository structure see Source Code.
Build MidPoint From Sources
Enter the directory with downloaded source code and execute either of the following commands:
mvn install
Complete build process also includes unit and integration tests and more than one hour. You can speed up the build by skipping automatic tests using the following command:
mvn install -DskipTests=true
After the successful build process there will be a binary distribution package located in dist/target
directory.
Building the WAR file only
If the WAR file is all you need you can speed the build even further by skipping the packaging of the distribution archive. Use the following command to turn off the dist
maven profile:
mvn clean install -DskipTests=true -P -dist
Please note the minus character (-) before profile name.
The resulting WAR file can be obtained from gui/admin-gui/target/midpoint.war
Run MidPoint
Continue with installation in the same way as for a binary release. See Trying MidPoint page. But you need to use your own freshly built distribution package instead of downloading it.