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
.ceror.pfxextension. - A matching private key file with the
.keyextension. - 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:
- 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. -
Set the Docker environment variables
XUIQ_PROXY_TLS_CERTandXUIQ_PROXY_TLS_KEYto the corresponding certificate and key paths inside the container, e.g., using a Docker Compose file or adocker runcommand.Docker Compose Example with TLSservices: 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: noReplace
<your-certificate>with your actual certificate and key file names. -
Start or recreate the container. Xtract Universal.iQ detects the provided certificates and configures TLS automatically when the container starts.
Xtract Universal.iQ is available over TLS at https://<hostname>:8080/. The hostname must match the name in the certificate.
Related Links
Written by: Valerie Schipka