Installing MidPoint 2.0 "Rhea" From Binary Distribution

Last modified 10 Mar 2021 15:54 +01:00

Introduction

This page describes the steps required to install midPoint from a binary distribution. This document describes the generic case suitable for trying out midPoint. For more complex installation scenarios please see Installation Guide.

Release Notes
Before you start the installation 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.

MidPoint is a Java web application distributed in a form of WAR archive. All that is essentially needed is to deploy it in a suitable container. This guide provides instructions to install midPoint in Apache Tomcat.

Before You Start

Java SE Development Kit 6

The development environment requires at least JDK 6 update 26. As far as after February 2013, Oracle will no longer post updates of Java SE 6 to its public download sites (see http://www.oracle.com/technetwork/java/eol-135779.html), recommended is JDK 7 which you can download at http://www.oracle.com/technetwork/java/javase/downloads/index.html.

JAVA_HOME environment variable should point to the JDK installation path.

Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files 6

Optional AES-128 is used by default for encrypt/decrypt operations, so JCE is not needed. If you want to use bigger key size, e.g. AES-256, then JCE is required for cryptographic operations. You can download it at http://www.oracle.com/technetwork/java/javase/downloads/index.html. After downloading zip file follow installation instructions written in README.txt

Apache Tomcat

midPoint needs an application server. Currently, Apache Tomcat 6.x or 7.x is supported. More application servers will be supported in later releases.

Apache Tomcat can be downloaded from http://tomcat.apache.org/download-70.cgi. The Apache Tomcat installation directory is further referenced as <tomcat>. In windows platform prefer downloading of zip file to downloading of windows installer as later do not populate bin directory with all batch files. You will start tomcat server via running the startup.bat file from <tomcat>\bin directory.

Installation

Download

Download the midPoint binary release according to the following table:

MidPoint 2.0 Binary Distribution

https://evolveum.com/downloads/midpoint/2.0/midpoint.war

Directory for Custom Components (midpoint.home)

If you intend to use custom connectors or schemas you need to create a directory anywhere on your system. This directory will be used to store your custom connector code, schemas, initial configuration and may also contains other files. MidPoint will populate that directory on first start. The directory will not be overwritten when midPoint is restarted or redeployed.

As an intended side-effect, this directory will also be used to store your embedded database repository data (H2 or BaseX).

If you don’t want to use custom connectors or you want just to try midPoint, you can skip this chapter and continue to the #Initialize Database.

Create the Directory

You can create your custom directory anywhere in your system. We often use locations such as /opt/midpoint or /var/opt/midpoint. The directory has to be writable by the application server user.

The directory structure is described here.

Tomcat "catalina.sh" Customization

To actually use the Custom Directory, modify the “catalina.sh” script located in <tomcat>/bin/catalina.sh and set the "JAVA\_OPTS" variable.

...
JAVA_OPTS="$JAVA_OPTS -Dmidpoint.home=/opt/midpoint -XX:MaxPermSize=256m"
...

Initialize Database

Repository initialization is not required, an embedded database repository (H2) will be used by default. The database files will be stored in midpoint.home directory.

Deploy midPoint

To deploy midPoint WAR file, use the following steps:

  1. Stop Tomcat if it’s already running.

  2. Copy midpoint.war to <tomcat>/webapps directory.

  3. Start Tomcat. It should pick up and deploy the "midpoint" application.

Test midPoint administration GUI

Log in to the midPoint administration console using the following URL:

Username administrator

Password

secret

A home page of the midPoint console should be displayed. This is a pretty dynamic web application using AJAX for better user interaction. The look&feel is quite minimalistic now, we are working on an improvement just now.

If there is a problem, please check Tomcat logs in <tomcat>/log/catalina.out and <tomcat>/log/idm.log.

For an quick introduction to use of midPoint please follow the instructions on First Steps page.

Download

Download the midPoint binary release according to the following table:

MidPoint 2.0 Binary Distribution

https://evolveum.com/downloads/midpoint/2.0/midpoint-2.0-dist.zip
https://evolveum.com/downloads/midpoint/2.0/midpoint-2.0-dist.tar.gz

Unpack the archive file to a convenient location. Following instructions will refer to the relative paths inside this archive.

Start MidPoint

All that remains is to start midPoint server up:

Starting midPoint (Linux)
bin/start.sh
Starting midPoint (Windows)
bin\start.bat

Try MidPoint

Log in to the midPoint administration console using the following URL:

Username

administrator

Password

5ecr3t

User dashboard should be displayed after login. In case of any problems, please check midPoint logs in var/log/ directory.

What To Do Next?

For an quick introduction to use of midPoint please follow the instructions on First Steps page or read through the midPoint book to get familiar with midPoint.

The Stand-Alone Deployment page describes layout of the installation directory.