ghcr.io/siriusscan/sirius-ui:sha-29138e195e758e9bdad723dea188aa5234271cf4

Sirius Scan

Sirius 是一款开源漏洞扫描器，具备自动发现、基于 CVE 的检测功能和现代化 Web UI。克隆代码库，运行四个命令，即可开始扫描。

快速开始

git clone https://github.com/SiriusScan/Sirius.git
cd Sirius
docker compose -f docker-compose.installer.yaml run --rm sirius-installer
docker compose up -d

打开 http://localhost:3000 并登录：

操作完成。所有六个服务将自动启动。安装程序在首次运行时会生成安全密钥，且可安全地重复运行。

默认情况下，安装程序未设置 IMAGE_TAG，因此 Compose 会从 GHCR 拉取 latest 标签镜像。如需固定版本（例如在 .env 中设置 v1.0.0），请确保该标签已存在于所有六个容器镜像中；可通过未登录 ghcr.io 的终端运行 bash scripts/verify-ghcr-public-access.sh v1.0.0 进行验证。

[!IMPORTANT] 要求：Docker Engine 20.10+ 并带有 Compose V2，4 GB 内存，10 GB 磁盘空间。支持 Linux、macOS 和 Windows（WSL2）。

Sirius 功能

• 网络发现——通过 Nmap 自动枚举主机和服务
• 漏洞检测——基于 CVE 的扫描并附带 CVSS 评分
• 风险仪表板——实时扫描进度、严重程度趋势和修复指南
• 远程代理——通过 gRPC 在多环境中进行分布式扫描
• 交互式终端——PowerShell 控制台，支持高级脚本编写和自动化
• REST API——与现有安全工作流集成（端口 9001 上使用 X-API-Key 认证）

部署选项

安装步骤始终相同，仅 docker compose up 命令有所变化。

非交互式设置（CI / Terraform / 自动化）

docker compose -f docker-compose.installer.yaml run --rm sirius-installer --non-interactive --no-print-secrets
docker compose up -d

轮换密钥

docker compose -f docker-compose.installer.yaml run --rm sirius-installer --force
docker compose up -d --force-recreate

验证安装

docker compose ps # 所有 6 个服务应显示 "healthy" 或 "running"
curl http://localhost:3000 # UI 响应
curl http://localhost:9001/health # API 响应

预期服务：sirius-ui（3000）、sirius-api（9001）、sirius-engine（5174、50051）、sirius-postgres（5432）、sirius-rabbitmq（5672、***）、sirius-valkey（6379）。

架构

graph TD
subgraph clients [客户端]
UI["Sirius UI (Next.js)"]
CLI["终端和代理运行时"]
end

subgraph core [核心服务]
API["Sirius API (Go/Gin)"]
Engine["Sirius Engine"]
end

subgraph infra [基础设施]
MQ["RabbitMQ"]
DB["PostgreSQL"]
Cache["Valkey"]
end

UI -->|"HTTP/WebSocket"| API
CLI -->|"gRPC"| Engine
API -->|"AMQP 发布"| MQ
MQ -->|"队列消费"| Engine
API -->|"SQL 读写"| DB
Engine -->|"SQL 读写"| DB
API -->|"会话/缓存操作"| Cache
Engine -->|"扫描状态缓存操作"| Cache

界面

API

Sirius 在端口 9001 上公开 REST 端点，受内部服务 API 密钥保护。建议使用 Docker 密钥文件（SIRIUS_API_KEY_FILE，默认 /run/secrets/sirius_api_key）；SIRIUS_API_KEY 仍作为环境变量 fallback 受支持。安装程序会写入 ./secrets/sirius_api_key.txt（权限 0644，以便非 root 应用 UID 可读取绑定挂载的密钥）并配置两者。

curl http://localhost:9001/health -H "X-API-Key: $SIRIUS_API_KEY"
curl http://localhost:9001/api/v1/scan/get/all -H "X-API-Key: $SIRIUS_API_KEY"

完整 API 文档：REST API 参考

安全建议

生产环境部署建议：

1. 轮换密钥——使用 --force 运行安装程序以重新生成所有凭据
2. 限制端口——仅暴露端口 3000（UI）；保持 5432、6379、5672 为内部端口
3. 使用反向代理——在前端部署 nginx 或 Traefik 并启用 TLS
4. 保持镜像更新——执行 docker compose pull && docker compose up -d

故障排除

常见问题的快速解决方法：

有关详细的操作手册、验证流程和紧急恢复，请参见 操作与故障排除。

贡献

开发设置、编码标准和 PR 指南参见 CONTRIBUTING.md。

延伸阅读

• 安装指南
• 界面导览
• 扫描指南
• Docker 架构
• 系统架构
• CI/CD 指南
• 操作与故障排除

许可证

MIT