Introduction

DirX Identity provides installation procedures to set up a complete DirX Identity environment. These procedures are divided into two main steps:

  1. Installation

    This step copies the required files to the file system and updates registry entries (on Windows) and environment variables (which requires a restart on Windows). The installation process supports both local and distributed DirX Identity systems.

  2. Configuration

    After installation, the configuration process extends the directory server schema for DirX Identity, loads initial data into DirX Identity domains, and configures all other components. The configuration procedure is tailored for local or distributed systems.

    See the section Schema and Content Handling for details.

Installation and configuration are clearly separated. First, select all components needed on a specific machine. Then, configure these components using the Configuration Wizard.

This chapter provides general information about installation and configuration. It does not cover distributed environment installation.

Version Updates and Service Packs

DirX Identity regularly introduces new versions to deliver enhancements and improvements. Between major releases, service packs are available to provide additional updates, which may include:

  • New functionality for DirX Identity Manager

  • Extended connectivity or provisioning configurations with new default applications

  • Updated or new agents and connectors

  • Documentation and help enhancements

  • Fixes for critical bugs

For the latest service pack information, contact your support organization.

General Information

This section applies to all DirX Identity installation procedures.

Supported Use Cases

  • New Installation: Install a supported directory server, then perform DirX Identity installation and configuration.

  • Update Installation: Refresh or repair existing installations. Backup and restore files as described in the Migration Guide.

  • Upgrade Installation: Install a new version and run configuration for automatic migration. Manual steps are detailed in the Migration Guide.

  • Uninstallation: Remove all installed software using the uninstallation and unconfiguration routines. LDAP configuration data remains intact.

Supported Use Cases

Supported Platforms

  • Directory Servers: DirX Directory Server (see Release Notes for version details)

  • Operating Systems: Microsoft Windows and Linux (see Release Notes for prerequisites and limitations)

Disk Space Requirements

  • Temporary: 2300 MB

  • Complete installation: Minimum 2500 MB

    Additional space is required for data and log files.

    See section Disk Space Calculation.

Firewall Configuration

Open the default ports for components you use. For example:

Service Non SSL SSL

Apache ActiveMQ broker

61616

61617

Apache ActiveMQ admin Web console

8161

8161

Apache ActiveMQ (JMX)

10098+10099

10098+10099

C++-based Server (SPML Service)

9900

9901

C++-based Server (proprietary JMX)

5315

5315

Java-based Server (HTTP/HTTPS Web services)

40_n_00

40_n_00

Java-based Server (JMX)

40_n_05+40_n_06

40_n_05+40_n_06

Tomcat deployments (defaults)

8080

8443

  • Ports can be changed during configuration; update firewall rules accordingly.

  • For IdS-J server, n = 0 for S1, 1 for S2, etc.

  • LDAP defaults: 389 (Non SSL), 636 (SSL).

  • Avoid port conflicts (e.g., Tomcat vs DirX Directory REST service).

  • JMX uses two ports: second = first + 1.

  • Additional ports may be required for connectors/agents.

  • C++ server uses port 1111 for local key transfer (do not open in firewall).

  • Windows ephemeral ports: 49152–65536.

Limitations

  • Installation must be performed locally (remote installation is not supported)

  • In distributed environments, update all machines to avoid interworking issues

  • Before updates or upgrades:

    • Stop all workflows and services

    • Stop all DirX Identity services and UI components, including Tomcat

Deploying Web Services

DirX Identity provides Web Services deployable in Apache Tomcat:

  • Stand-alone Tomcat or embedded in IdS-J server (default port 40000).

  • Embedded deployments start/stop with IdS-J server.

  • External Tomcat service operation is out of scope.

Linux Configuration Account Requirements

Superuser permissions are sufficient. If using DirX Identity installation account:

  • Tomcat installation conditions

    • Account must have read/write/execute access to Tomcat directory.

    • Required subdirectories: conf/Catalina/localhost, work/Catalina/localhost.

    • Permissions: 775 (shared group) or 777 (otherwise).

  • LDAP directory conditions:

    • Superuser required for configuration.

    • DirX home directory must be readable/executable for group members.

    • Define Linux group including DirX and DirX Identity accounts.

Accounts for Tomcat and DirX Identity (Linux Only)

Tomcat account must have read/write access to password.properties files of Web Apps (e.g., Web Center). Options:

  • Install Tomcat as superuser.

  • Define shared Linux group.

  • Install Tomcat under DirX Identity account.