Run in Docker

This page shows how to run Xtract Universal.iQ in a Docker container.

The Xtract Universal.iQ setup package contains everything needed to start the software locally or in a server environment. The package consists of the following files:

About the Docker Container

Once the Xtract Universal.iQ container is set up, the directories that contain your configuration and log files are mapped to a volume to ensure your configuration persists even after shutting down or deleting the container. You can mount the configuration into any new container you create in the future.

For more information about the folder structure inside the container, see Container Directories.

Prerequisites

To run in a Docker environment, Xtract Universal.iQ requires:

• Docker Desktop
• Administrator rights

Load the Container Image

To load the Xtract Universal.iQ image into Docker:

1. Copy the xtract-universal-iq.docker.tar.gz file to a local directory of your choice, e.g. C:\Docker\xtract-universal-iq\.
2. Start Docker Desktop to run the Docker Engine in the background.

3. Open a terminal, e.g., PowerShell on Windows, and navigate to the directory that contains the xtract-universal-iq.docker.tar.gz file:

   cd C:\Docker\xtract-universal-iq
   

4. Use the following command to load the Xtract Universal.iQ image into Docker:

   docker load -i .\xtract-universal-iq.docker.tar.gz
   

   Loading the image might take some time. If successful, the console returns the image name, e.g., Loaded image: xtract-universal-iq:9926.4.20.6.

5. Copy or note the image name for later use.

The Xtract Universal.iQ image is now available in Docker and can be used to create containers.

Apply the (Demo) License

To ensure that the demo license is applied when running the container, create a folder input\ in your local directory, e.g., C:\Docker\xtract-universal-iq\input\. This folder will be mapped into the container. Move the XtractUniversalIqLicense.json file into the input\ directory.

Create the Container

The following command creates and runs a container that uses the Xtract Universal.iQ image. Replace the image name after the -d parameter with your actual image name.

docker run `
--name xtract-universal-iq `
--network=bridge `
--restart=no `
-p 8075:8075 `
-p 8076:8076 `
-p 8077:8077 `
-p 8078:8078 `
-p 8175:8175 `
-p 8176:8176 `
-p 8177:8177 `
-p 8178:8178 `
--runtime=runc `
-t `
-v .\data\:/xtract-universal-iq/data/ `
-v .\input\:/xtract-universal-iq/input/ `
-d xtract-universal-iq:9926.4.20.6 `
/bin/bash

docker run \
--name xtract-universal-iq \
--network=bridge \
--restart=no \
-p 8075:8075 \
-p 8076:8076 \
-p 8077:8077 \
-p 8078:8078 \
-p 8175:8175 \
-p 8176:8176 \
-p 8177:8177 \
-p 8178:8178 \
--runtime=runc \
-t \
-v .\data\:/XtractUniversaliQ/data/ \
-v .\input\:/XtractUniversaliQ/input/ \
-d xtract-universal-iq:9926.6.17.37 \
/bin/bash

You can access the container from the browser of your host machine using http://localhost:8077/.