semarchy/xdi-license-server repository overview

⁠Quick reference

• Maintained by: Semarchy⁠
• Where to get help: Semarchy Community⁠ and Semarchy Support Library⁠.

⁠Version

For the versions available, see the tags on this repository⁠.

See also Global Support Policy⁠ for more information about the available versions, their support and maintenance plan.

⁠Semarchy xDI License Server

Semarchy, a leader in the data integration and master data management markets, enables organizations to rapidly generate business value from their data. Its unified platform enables organizations of any size, to quickly discover, govern, manage, integrate, and report critical information scattered across applications.

Semarchy xDI is a high-performance, agile, and extensible data integration platform supporting any integration style and use case. The Semarchy xDI License Server is used to validate the Semarchy xDI user licenses.

For more information, visit www.semarchy.com⁠.

⁠Base image

The Semarchy xDI License Server images are using an OpenJDK base image⁠ composed of:

• Debian image
• OpenJDK version supported by Semarchy xDI License Server⁠

For example: eclipse-temurin:11-jdk-jammy

⁠Docker Compose Sample

Use the Docker Compose Sample⁠ as a template to create your own Docker Compose file.

⁠Usage

To run the server you need to:

1. Download and uncompress the Tutorial Resources⁠.
   The quick-install/docker/<version>/xdi-license-server/docker-compose/ folder contains the docker-compose.yml file as well as a shared-resources folder with sample configuration files.
   NOTE: The configuration files in this folder are mounted to corresponding locations in the container by the Docker Compose.

2. Copy the license.xml file provided by Semarchy to the shared-resources folder.
   NOTE: The license.xml file in this folder is also mounted to the corresponding location in the container by the Docker Compose.

3. Edit the spring-context.xml and realm.properties files in the shared-resources/conf folder to adapt the configuration to your requirements.
   For example, edit the configuration files for defining the required TLS certificate. See Configure the License Server⁠ for more information about the license server configuration.

4. Edit the Docker Compose file to define the port exposed by the license server.

5. Run the following command from the Docker Compose file location

   $ docker compose -f <your_docker_compose>.yml up

You can now use this license server to register your Semarchy xDI Designer⁠ by entering the URL and Key provided by Semarchy for your Local Server.

⁠Documentation

This Docker Compose creates and starts a complete instance of Semarchy xDI License Server.

See Semarchy xDI License Server Documentation⁠ for detailed usage.

⁠Configuration

The spring-context.xml and realm.properties files, located in the shared-resources folder are sample configuration files for the license server container.

They should be mounted on the container (see the sample Docker Compose file) in the following locations:

• /opt/semarchy/xdi-license-server/conf/spring-context.xml'
• /opt/semarchy/xdi-license-server/conf/realm.properties'.

NOTE: For more information about these configuration files, see configure the License Server⁠ in the Semarchy xDI documentation.

⁠Logs

The Semarchy xDI License Server startup logs are redirected to the container logs⁠.

Additional log information can be found in the /opt/semarchy/xdi-license-server/log folder, which can optionally be mounted as a volume.

⁠Image Tags

The xdi-license-server images are available with different options, each designed for a specific use case.

⁠xdi-license-server:latest

This image contains the latest version of the Semarchy xDI License server. See details about Semarchy xDI Architecture⁠.

Important: this is not recommended to use the latest tag in production, as it will automatically upgrade to the latest version that Semarchy is publishing.

⁠xdi-license-server:<minor_version>

This image contains the latest version for a specific minor version of the Semarchy xDI License server.

For example: semarchy/xdi-license-sever:2023.3

Important: this is not recommended to use the minor_version tag in production, as it will automatically upgrade to the latest patch version that Semarchy is publishing.

⁠xdi-license-server:<full_version>

This image contains a specific full version of the Semarchy xDI License server.

For example: semarchy/xdi-license-server:2023.1.4

⁠License

View license information⁠ for the software contained in this image.