Skip to content

Transport Layer Security for the Xtract Universal.iQ Designer

The following article shows how to set up Transport Layer Security (TLS) with an X.509 certificate.
TLS ensures secured communication and authentication with Xtract Universal.iQ.

About X.509 Certificates

There are two main approaches for creating an X.509 certificate:

  • Certificate released by an (internal) certification authority (CA)
  • Self-signed certificate

On test environments you can use a self-signed certificate. For production environment it is recommended to use a certificate released by an (internal) certificate authority (CA).

Depending on whether Xtract Universal.iQ is hosted on a local server or a cloud environment, the procedure for certificate creation differs. Refer to your network administrators for assistance.

Requirements

  • A valid X.509 certificate file with the .cer or .pfx extension.
  • A matching private key file with the .key extension.
  • Access to the input/certs/ directory used by the Xtract Universal.iQ container.

Note

The first Subject Alternative Name provided by the X.509 certificate is used as the hostname for Xtract Universal.iQ.

Activate TLS in Xtract Universal.iQ

To set up Transport Layer Security (TLS) in your Xtract Universal.iQ Docker environment:

  1. Place the certificate and matching private key in the input/certs/ directory used by the Xtract Universal.iQ container, see Knowledge Base Article: Container Directories.
  2. Set the Docker environment variables XUIQ_PROXY_TLS_CERT and XUIQ_PROXY_TLS_KEY to the corresponding certificate and key paths inside the container, e.g., using a Docker Compose file or a docker run command.

    Docker Compose Example with TLS
    services:
      app:
        image: registry.theobald-software.com/theobald-software/xtract-universal-iq:latest
        container_name: XtractUniversaliQ
        ports:
    
          - "8080:8080"
        volumes:
          - ./data:/XtractUniversaliQ/data
          - ./input:/XtractUniversaliQ/input:ro
        environment:
          XUIQ_PROXY_TLS_CERT: /XtractUniversaliQ/input/certs/<your-certificate>.cer
          XUIQ_PROXY_TLS_KEY: /XtractUniversaliQ/input/certs/<your-certificate>.key
        restart: no
    

    Replace <your-certificate> with your actual certificate and key file names.

  3. Start or recreate the container. Xtract Universal.iQ detects the provided certificates and configures TLS automatically when the container starts.

    docker compose up --force-recreate
    

Xtract Universal.iQ is available over TLS at https://<hostname>:8080/. The hostname must match the name in the certificate.



Last update: November 16, 2026
Written by: Valerie Schipka