Install the Semarchy xDI Runtime

This document details how to install Semarchy xDI Runtime.

Before the installation, make sure to understand the architecture and carefully review 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 to a temporary directory.

  2. Move the archive content to the target installation directory.

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

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

    • ./temp

    • ./build

    • ./sessions

  5. Configure the Runtime if necessary.

With the default configuration, the Runtime only listens on localhost and requires to logging in with the default users defined in the configuration file. This default configuration is for security purposes. We recommend configuring the runtime security with the settings corresponding to your requirements.
For security concerns, it is recommended to install and start the runtime with a dedicated user having only the necessary operating system permissions.

Start the Runtime

To start the Runtime:

  1. In the bin/ sub-directory of the Runtime installation directory, run the startengine.bat (Windows) or startengine.sh (Linux or macOS) file.
    The Runtime starts.

Use the stopengine.bat (Windows) or stopengine.sh (Linux or macOS) scripts to stop the Runtime.

For security concerns, it is recommended to install and start the runtime with a dedicated user having only the necessary operating system permissions.