Install the Semarchy xDI Runtime

This document details how to install Semarchy xDI Runtime

Before the installation, make sure to understand the architecture and review carefully the system requirements.

Download the Runtime

The Runtime is shipped as an archive file. It runs on any platform with a supported Java Virtual Machine.

Install the Runtime

  1. Uncompress the Runtime archive and uncompress it file to a temporary directory. Move the archive content to the target installation directory.

  2. Check and set, if needed, execution permission on all the .bat (Windows) and .sh (Linux or macOS) scripts located at the root of the installation directory.

  3. Check and set, if needed, write permission on the following sub-directories:

    • ./temp

    • ./build

    • ./sessions

  4. Configure the Runtime if necessary.

With the default configuration, the Runtime listens on localhost only and requires to log in with the default users defined in the configuration file. This default configuration is for security purposes. We recommend to configure the runtime security with the settings corresponding to your requirements.

Runtime as a Service


To install the runtime as a Windows service, use the following scripts provided in the runtime installation folder:

  1. installEngineAsService.bat -i [<Service Name>] to add a runtime service.

  2. installEngineAsService.bat -r [<service Name>] to remove a runtime service.

The optional <Service Name> parameter allows installing multiple runtimes in the same machine. When unset, the service name defaults to Semarchy xDI Runtime.

Depending on the operating system configuration, you might need to run these commands as a system administrator.

Any change performed in the runtime configuration file or script files (.properties or .bat files) requires removing and adding again the runtime service.
When starting multiple runtime services, make sure to configure the services for each runtime on different ports.
The user configured to start the runtime Windows service must have network capabilities. It is typically a domain user.


To install the runtime as a Linux/Unix service, refer to the service setup procedure specific to your operating system. This usually requires a startup script and a shutdown script for the runtime process.

  • The runtime startup script is

  • The runtime shutdown script is