社区版部署指南
本文档介绍如何快速部署华杨 CMDB 社区版本。社区版适用于产品体验、功能评估和培训演示场景。
前置要求
运行环境
-
操作系统：Linux（64 位）。推荐 Ubuntu 22.04 / 24.04 LTS。其他支持安装 Docker CE 的 Linux 发行版均可运行。
-
Docker 要求：推荐安装 Docker CE 20.10 及以上版本。
Docker 20.10+ 已内置 Docker Compose V2 插件，用户可直接使用
docker compose命令，无需再单独安装旧版docker-compose。
硬件配置
| 配置项 | 最低配置 | 推荐配置 |
|---|---|---|
| CPU | 4 核 | 8 核或以上 |
| 内存 | 8 GB | 16 GB 或以上 |
| 硬盘 | 100 GB SSD | 200 GB 或以上 SSD |
网络要求
- 端口
443未被其他服务占用 - 如需远程访问，请确保防火墙已开放
443端口
社区版安装为在线模式：安装脚本会从公开镜像仓库（华为云 SWR）拉取所需镜像，安装机器需可访问公网。
安装步骤
1. 获取安装文件
您可以通过以下任一方式获取安装文件：
方式一：从代码仓库获取
从项目官方代码仓库克隆或下载安装文件，下载后的目录结构与解压后的安装包一致。
方式二：从官网下载安装包并解压
从华杨官网下载页获取安装包：https://www.huayung.com.cn/download.html
tar -zxvf hyo-cmdb-2.0.0-community.tar.gz
2. 进入安装目录
进入安装文件所在目录：
# 若从代码仓库获取
cd <项目目录>
# 若解压安装包
cd hyo-cmdb-2.0.0-community
3. 运行安装脚本
sudo ./scripts/install.sh <host_FQDN>
参数说明：<host_FQDN> 为包含域名的完整主机名。
安装脚本会自动检测操作系统语言，输出中文或英文提示；也可显式指定：
sudo ./scripts/install.sh <host_FQDN> --lang en # 强制英文输出
sudo ./scripts/install.sh <host_FQDN> --lang zh # 强制中文输出
如需指定镜像版本，可追加 --imageTag <tag>。
本应用必须通过域名访问，不能使用 IP 地址。请选择以下任一方式配置：
方式一：真实域名
将您的域名 DNS 解析指向安装机器的 IP，安装时传入该域名（如 app.yourcompany.com）。
方式二：修改 hosts 文件
在每台需要访问的客户端机器上，以管理员身份编辑 hosts 文件，添加一行：
<机器IP> <自定义域名>
例如：192.168.1.100 mycommunity.local
- Linux/macOS：编辑
/etc/hosts - Windows：编辑
C:\Windows\System32\drivers\etc\hosts
安装时传入该自定义域名（如 mycommunity.local），之后通过 https://mycommunity.local/... 访问。
4. 等待安装完成
安装脚本会自动执行以下操作：
- 从公开镜像仓库拉取镜像
- 生成 SSL 证书（如不存在）
- 启动所有服务容器
安装完成后，终端会显示访问地址。
访问华杨 CMDB
安装完成后，通过浏览器访问：
https://<host_FQDN>/itom/ui/100000001
默认端口为 443（标准 HTTPS 端口，URL 中无需带端口号）。若将安装目录下 .env 中的 WEBSECURE_PORT 改为非 443/80 的端口，则访问地址需带上该端口，如 https://<host_FQDN>:<port>/itom/ui/100000001。
默认登录账号：
- 用户名：
admin - 密码：
Admin_1234
默认密码仅用于首次登录，请登录后立即修改，切勿在生产环境沿用默认凭据。
AI 助手模型配置（可选）
CMDB 内置 AI 助手，支持自然语言查询资产、对话问答等能力。AI 助手依赖外部大模型服务，需编辑安装目录下的 .env 文件配置以下三个变量：
vi .env
| 变量 | 说明 |
|---|---|
ITOM_MODEL_NAME | 模型名称（取决于供应商，如 MiniMax-M3、gpt-4o、glm-4 等） |
ITOM_MODEL_BASE_URL | 供应商的 OpenAI 兼容 API 地址 |
ITOM_MODEL_API_KEY | 供应商颁发的 API Key |
常见供应商示例：
| 供应商 | ITOM_MODEL_NAME | ITOM_MODEL_BASE_URL |
|---|---|---|
| MiniMax | MiniMax-M3 | https://api.minimaxi.com/v1 |
| OpenAI | gpt-4o | https://api.openai.com/v1 |
| 智谱 GLM | glm-4 | https://open.bigmodel.cn/api/paas/v4 |
配置说明：
-
三项必须全部填写才会启用 AI 助手；任意一项留空则 AI 助手不可用（不影响产品的核心功能）。
-
配置完成后需重启 AI 服务生效：
docker compose up -d ai-agent -
.env中的辅助任务模型（ITOM_MEMORY_*、ITOM_ARTIFACT_*、ITOM_PII_LLM_*）为可选的成本优化项，留空时自动回退到上方主模型，无需额外配置。
常用运维操作
请确保先进入解压后的安装目录再执行下列命令。
查看服务状态
docker compose ps
查看日志
# 查看所有服务日志
docker compose logs -f
# 查看指定服务日志
docker compose logs -f <service_name>
服务的持久化日志文件也写入安装目录的 logs/ 下（按服务分目录，与 docker compose logs 同源且自带轮转）：
ls logs/ # 各服务日志目录（cmdb / api / ai-agent / monitoring / cmdb-ui / proxy / traefik）
tail -f logs/cmdb/system/itom.log
# traefik 网关访问日志：logs/traefik/access.log
# 审计日志：logs/<service>/audit/system/audit.log
重启服务
docker compose restart
停止服务
docker compose down
完全卸载
此操作会删除所有数据，不可恢复。
docker compose down -v
常见问题
执行 docker compose 命令报错 "no configuration file provided: not found"
原因：docker compose 需要在包含 docker-compose.yml 的目录下执行。如果不处于解压后的安装目录中，将找不到配置文件。
解决方法：确保先进入解压后的安装目录再执行命令：
cd hyo-cmdb-2.0.0-community
docker compose ps
浏览器提示证书不安全
原因：社区版默认使用自签名 SSL 证书。
解决方法：在浏览器中点击"高级"→"继续访问"即可。生产环境建议使用正式 CA 签发的证书（参见企业版部署指南）。
下一步
安装完成后，您可以：