交付包安装

网关以交付包 RST-AI-Copilot-for-QRadar-<版本>.tar.gz 发布在 GitHub Releases，同名 .sha256 文件用于校验。交付包内含全部镜像和部署文件，由其中的 deploy.sh 完成安装：加载镜像，收集配置，写入 .env，启动容器。1.0.1 起，install.sh 把下载、校验、解压和执行 deploy.sh 合为一条命令。

交付包内容

RST-AI-Copilot-for-QRadar-<版本>/
├── RST-AI-Copilot-for-QRadar-images-<版本>.tar   # 网关、Caddy、PostgreSQL 镜像
├── deploy.sh                                 # 交互式安装脚本
├── docker-compose.prod.yml                   # 网关自带登录
├── docker-compose.sso.yml                    # SSO
├── Caddyfile、Caddyfile.sso
├── .env.example                              # 全部配置项及说明
├── deploy/rst-update.sh                      # 在线更新安装器
├── scripts/backup.sh、scripts/restore.sh
└── docs/                                     # DEPLOYMENT.md、BACKUP.md、RELEASE-NOTES.md

deploy.sh 启动容器前检查 compose 文件用到的镜像是否都已在本机。缺少镜像时列出镜像名并询问是否在线拉取，离线主机选择否时安装中止。

用一条命令安装

1.0.1 起可用。

前提条件

• 主机已安装 Docker Engine 24 及以上和 Docker Compose v2。
• 主机可以访问 github.com。
• 在交互式终端中执行，deploy.sh 需要读取输入。

步骤

1. 执行安装命令：

   curl -fsSL https://github.com/Reallysec/RST-AI-Copilot-for-QRadar/releases/latest/download/install.sh | sudo bash

   所有版本使用同一个交付包：未激活许可时以社区版运行，在 系统设置 的 产品激活 中激活许可后，原地解锁对应版本的功能，不需要重装。

2. 按 deploy.sh 的提示填写配置，见下文 deploy.sh 的提问。

脚本把交付包解压到 /opt/rst-ai-copilot-for-qradar 后执行 deploy.sh。1.1.15 及更早版本安装在 /opt/rst-qradar-ai-copilot 的主机在原目录升级。在同一台主机再次执行时，该目录中的 .env 和 state/ 保留，许可的主机指纹不变。因此同一条命令也用于升级。

在离线主机上安装

步骤

1. 在可以访问 GitHub 的机器上下载并校验交付包：

   curl -fsSL https://github.com/Reallysec/RST-AI-Copilot-for-QRadar/releases/latest/download/install.sh | bash -s -- --download-only

2. 把当前目录中的 RST-AI-Copilot-for-QRadar-<版本>.tar.gz 和 .sha256 文件拷到离线主机。

3. 在离线主机上按下文 手动安装交付包 执行。

手动安装交付包

步骤

1. 从 GitHub Releases 下载 RST-AI-Copilot-for-QRadar-<版本>.tar.gz 与同名 .sha256 文件。所有版本使用同一个交付包，功能范围由激活的许可决定。

2. 校验并解压：

   sha256sum -c RST-AI-Copilot-for-QRadar-<版本>.tar.gz.sha256
   tar xzf RST-AI-Copilot-for-QRadar-<版本>.tar.gz
   cd RST-AI-Copilot-for-QRadar-<版本>

3. 执行 sudo ./deploy.sh，按提示填写配置。

deploy.sh 的提问

脚本分七步执行：预检、加载镜像、检查现有 .env、选择认证方式、填写配置、写入 .env、启动。预检时生成 state/machine-id 与 state/server_guid，这两个文件是许可的硬件指纹，已存在时复用。已有 .env 时，脚本询问是否保留并直接启动，升级时选择保留。

脚本自动生成 RST_GATEWAY_SHARED_SECRET、RST_ADMIN_TOKEN、RST_USER_DB_PASSWORD 和管理员口令哈希，写入 .env，权限 600。启动后最多等待 90 秒至全部容器 healthy，然后打印运行版本和访问地址。

验证安装

步骤

1. 检查健康与就绪状态：

   curl -k https://<域名>/healthz     # {"status":"ok"}
   curl -k https://<域名>/readyz
   docker compose -f docker-compose.prod.yml ps

2. 打开 https://<域名>/v2/，以 admin 和安装时设置的口令登录。

readyz 正常时返回 {"status":"ready","qradar":"ok","qradar_version":"<Console 版本>","qradar_configured":true}。返回 503 时，qradar 是原因：not_configured 表示没有填写 Console，其他值是连接 Console 的错误信息。qradar_configured 为 false 时，.env 中的 QRADAR_URL 或 QRADAR_SEC_TOKEN 为空，登录后界面弹出连接设置对话框。

默认证书为自签证书。生产环境修改 Caddyfile，换成自有证书。

不使用 deploy.sh 安装

步骤

1. 加载镜像并准备 .env：

   docker load < RST-AI-Copilot-for-QRadar-images-<版本>.tar
   cp .env.example .env

2. 在 .env 中填写 LLM_API_KEY、LLM_MODEL、QRADAR_URL、QRADAR_SEC_TOKEN、CADDY_SITE_ADDRESS、RST_GATEWAY_SHARED_SECRET、RST_ADMIN_TOKEN、RST_USER_DB_PASSWORD，并设置 GATEWAY_IMAGE_TAG=<版本>。

3. 生成管理员口令哈希，写入 .env 的 RST_ADMIN_PASSWORD_HASH。哈希中的 $ 写成 $$：

   docker run --rm rst-ai-copilot-for-qradar-gateway:<版本> python -m backend.session_auth '<口令>'

4. 生成主机指纹文件：

   mkdir -p state
   openssl rand -hex 16 > state/machine-id
   cat /proc/sys/kernel/random/uuid > state/server_guid
   chmod 644 state/*

5. 执行 docker compose -f docker-compose.prod.yml up -d。

后续操作

1. 使用付费引擎时，在产品激活中激活许可。
2. 在系统设置中配置日志源白名单、脱敏档位和审计。
3. 把 ./state/、gateway_state 卷和 userdb_data 卷纳入备份，见升级、回滚与备份。