Skip to main content
Installation

Requirements and network

Host size, Docker version, QRadar version, the authorized-service token, the LLM endpoint, the hostname, and the inbound and outbound ports to open before installing.

RST AI Copilot for QRadar ships as three Docker containers: the gateway, a Caddy reverse proxy that terminates TLS, and PostgreSQL for the account table. It does not include QRadar. It connects to your existing Console with one authorized-service token and reads events, flows, offenses, rules and log sources from there. The gateway keeps its own state in one SQLite file, copilot.db, on a Docker volume, and leaves nothing on the QRadar side.

The archive carries the images for all three containers, so installation needs no registry access.

Architecture and network

Host

ItemRequirement
OSUbuntu 20.04, 22.04, 24.04 or an equivalent Linux (Debian, RHEL family)
SizeAt least 2 vCPU, 4 GB RAM and 20 GB disk. The gateway container is capped at 2 CPU and 2 GB by default, set by RST_GATEWAY_CPUS and RST_GATEWAY_MEM
RuntimeDocker Engine 24 or later, Docker Compose v2
PrivilegesAn account that can run docker. The one-command install needs root

QRadar

ItemRequirement
Version7.5 or later, REST API 20.0 (the QRADAR_API_VERSION default). Verified on 7.6.0 FP1. 7.4 (API 16.0) has not been tested
NetworkThe gateway host reaches the Console on 443. The gateway talks to the Console only, never to an Event Processor
CertificateThe Console certificate is not verified by default. For a trusted certificate, set RST_QRADAR_VERIFY_CERTS=true; for a private CA, put the PEM file in ./certs/ and set RST_QRADAR_CA_CERT
TokenOne authorized-service SEC token. See QRadar token permissions

LLM

Any OpenAI-compatible endpoint: Volcengine Ark, DeepSeek, Qwen, Azure OpenAI, self-hosted vLLM or Ollama. Installation asks for the URL, API key and model name. Air-gapped sites use a local model with the air-gapped masking mode. You can add more providers in AI settings after installation.

On a reasoning model, triage, investigation and rule drafting take tens of seconds to minutes per call. The per-call timeout LLM_TIMEOUT_S defaults to 180 seconds; raise it for slow models.

Hostname

Set CADDY_SITE_ADDRESS to a hostname such as copilot.corp.local. An IP literal is not a valid TLS SNI, and some browsers refuse the handshake. Without internal DNS, add a hosts entry on the analysts' machines.

Ports

Inbound, to the gateway host:

PortFromPurpose
443/TCPAnalyst networkhttps://<hostname>/v2/, the only entry point
80/TCPAnalyst networkHTTP to HTTPS redirect, optional

The gateway's port 8000 and the account database's port 5432 stay on the internal compose network and are not exposed.

Outbound, from the gateway host:

TargetPortPurposeRequired
QRadar Console443Ariel searches, offense sync, rule and log-source catalog, platform check-upYes
LLM endpoint443InferenceYes. Internal for a local model
license.reallysec.com443Activation, heartbeatFor commercial licenses activated online. Not needed by an unactivated Community install or an offline license
github.com, release-assets.githubusercontent.com443Online update: a daily check for new versions and content packs, and the archive download. The release manifest and content packs are read from GitHub ReleasesFor online update, in every edition. Hosts activated offline do not connect
Feishu, DingTalk, WeCom, Teams, Slack, SMTP443, 465, 587Outbound channelsOptional
syslog receiver, which can be QRadar itself514, 6514Audit forwarding, EnterpriseOptional

On this page