Skip to main content

​
Before you begin

  • Review System Requirements
  • Obtain your license key and container registry credentials from Intrace

​
Docker Compose

​
1. Authenticate with the container registry

docker login registry.intrace.ai \
  --username YOUR_REGISTRY_USERNAME \
  --password YOUR_REGISTRY_PASSWORD

​
2. Download the Compose bundle

curl -O https://releases.intrace.ai/intelligence-engine/latest/docker-compose.yml
curl -O https://releases.intrace.ai/intelligence-engine/latest/.env.example
cp .env.example .env

​
3. Configure the environment

Edit .env with your deployment-specific values. See Configuration for a full reference of all environment variables. At minimum, set: 
INTRACE_LICENSE_KEY=your_license_key
INTRACE_DEPLOYMENT_ID=your_deployment_id
DATABASE_URL=postgresql://user:password@db:5432/intelligence

​
4. Start the engine

docker compose up -d

​
5. Verify the deployment

curl -f https://your-hostname/health
A successful response returns {"status": "ok"}. If the response includes "license": "invalid" or the service fails to start, check that INTRACE_LICENSE_KEY is set correctly and that license.intrace.ai:443 is reachable from the host.

​
6. Verify connector reachability

curl -H "X-API-Key: your_api_key" https://your-hostname/v1/connectors
Review the status field for each connector. Any connector with "status": "unreachable" requires a firewall egress rule. See Connector Reference for the required hostnames and ports per connector.

​
First-run health check

After installation, confirm the following before routing production traffic:
  • /health returns {"status": "ok"}
  • License is valid (check engine logs for license validated)
  • At least one connector is reachable via GET /v1/connectors
  • SAML/OIDC or API key authentication is working (see Identity Provider Setup)
  • A test lookup returns a response (even "status": "no_match" confirms the pipeline is working)

​
Next step

Configuration Reference