Version: next

Community Edition Deployment Guide

This document describes how to quickly deploy the Huayang CMDB Community Edition. The Community Edition is intended for product trials, feature evaluation, and training/demo scenarios.

Prerequisites

Runtime Environment

Operating System: Linux (64-bit). Ubuntu 22.04 / 24.04 LTS is recommended. Any other Linux distribution that supports Docker CE installation will also work.
Docker Requirements: Docker CE 20.10 or above is recommended.

Docker 20.10+ includes the Docker Compose V2 plugin built in, so you can use the docker compose command directly without separately installing the legacy docker-compose.

Hardware Requirements

Component	Minimum	Recommended
CPU	4 cores	8 cores or more
Memory	8 GB	16 GB or more
Disk	100 GB SSD	200 GB or more SSD

Network Requirements

Port 443 must not be in use by other services
For remote access, ensure the firewall has port 443 open

Note

The Community Edition installs in online mode: the installer pulls the required images from a public registry (Huawei Cloud SWR), so the installation machine must have internet access.

Installation Steps

1. Obtain the Installation Files

You can obtain the installation files using either of the following methods:

Method 1: From the Code Repository

Clone or download the installation files from the project's official code repository. The downloaded directory structure is identical to the extracted installation package.

Gitee: https://gitee.com/hyo-tech/CMDB
GitHub: https://github.com/hyo-tech/CMDB

Method 2: Download and Extract the Package from the Official Website

Download the package from the Huayang official download page: https://www.huayung.com.cn/download.html

tar -zxvf hyo-cmdb-2.0.0-community.tar.gz

2. Enter the Installation Directory

Navigate to the directory containing the installation files:

# If obtained from the code repository
cd <project-directory>

# If extracted from the package
cd hyo-cmdb-2.0.0-community

3. Run the Installation Script

sudo ./scripts/install.sh <host_FQDN>

Parameter Description: <host_FQDN> is the fully qualified host name, including its domain.

The installer auto-detects the OS language and prints Chinese or English prompts; you can also force a language explicitly:

sudo ./scripts/install.sh <host_FQDN> --lang en   # Force English output
sudo ./scripts/install.sh <host_FQDN> --lang zh   # Force Chinese output

To pin a specific image version, append --imageTag <tag>.

This application must be accessed via a domain name, not an IP address. Configure this using either of the following methods:

Option 1: Real Domain Name

Point the DNS record for your domain to the installation machine's IP, and pass that domain (e.g. app.yourcompany.com) to the installer.

Option 2: Edit the Hosts File

On each client machine that needs access, edit the hosts file as an administrator and add a line:

<machine_IP>   <custom_domain>

Example: 192.168.1.100 mycommunity.local

Linux/macOS: edit /etc/hosts
Windows: edit C:\Windows\System32\drivers\etc\hosts

Pass that custom domain (e.g. mycommunity.local) to the installer, then access the application via https://mycommunity.local/....

4. Wait for Installation to Complete

The installation script automatically performs the following operations:

Pull images from the public registry
Generate the SSL certificate (if one does not already exist)
Start all service containers

After installation is complete, the terminal displays the access URL.

Access Huayang CMDB

After installation, open the following URL in a browser:

https://<host_FQDN>/itom/ui/100000001

The default port is 443 (the standard HTTPS port, so no port is shown in the URL). If you change WEBSECURE_PORT in the .env file inside the installation directory to a port other than 443/80, the access URL must include that port, e.g. https://<host_FQDN>:<port>/itom/ui/100000001.

Default login credentials:

Username: admin
Password: Admin_1234

Security Notice

The default password is for first-time login only. Change it immediately after logging in, and never keep the default credentials in a production environment.

AI Assistant Model Configuration (Optional)

Huayang CMDB ships with a built-in AI assistant that supports querying assets in natural language, conversational Q&A, and more. The AI assistant relies on an external large-language-model service and requires the following three variables to be configured in the .env file inside the installation directory:

vi .env

Variable	Description
`ITOM_MODEL_NAME`	Model name (depends on the provider, e.g. `MiniMax-M3`, `gpt-4o`, `glm-4`)
`ITOM_MODEL_BASE_URL`	The provider's OpenAI-compatible API endpoint
`ITOM_MODEL_API_KEY`	API key issued by the provider

Common provider examples:

Provider	`ITOM_MODEL_NAME`	`ITOM_MODEL_BASE_URL`
MiniMax	`MiniMax-M3`	`https://api.minimaxi.com/v1`
OpenAI	`gpt-4o`	`https://api.openai.com/v1`
Zhipu GLM	`glm-4`	`https://open.bigmodel.cn/api/paas/v4`

Configuration notes:

All three variables must be filled in to enable the AI assistant; if any one is left empty, the AI assistant is unavailable (this does not affect the core functionality of the product).
After configuration, restart the AI service for the changes to take effect:
```
docker compose up -d ai-agent
```
The auxiliary-task model variables in .env (ITOM_MEMORY_*, ITOM_ARTIFACT_*, ITOM_PII_LLM_*) are optional cost-optimization knobs; when left empty they automatically fall back to the main model above, so no extra configuration is required.

Common Operations

Make sure to enter the extracted installation directory before executing the following commands.

View Service Status

docker compose ps

View Logs

# View logs for all services
docker compose logs -f

# View logs for a specific service
docker compose logs -f <service_name>

Persistent log files for each service are also written under the logs/ directory of the installation folder (organized per service, same source as docker compose logs, with built-in rotation):

ls logs/                      # Per-service log directories (cmdb / api / ai-agent / monitoring / cmdb-ui / proxy / traefik)
tail -f logs/cmdb/system/itom.log
# traefik gateway access log: logs/traefik/access.log
# Audit log: logs/<service>/audit/system/audit.log

Restart Services

docker compose restart

Stop Services

docker compose down

Full Uninstall

Warning

This operation deletes all data and is irreversible.

docker compose down -v

Frequently Asked Questions

`docker compose` reports "no configuration file provided: not found"

Cause: docker compose must be run inside the directory that contains docker-compose.yml. If you are not in the extracted installation directory, the configuration file cannot be found.

Solution: Make sure to enter the extracted installation directory before running commands:

cd hyo-cmdb-2.0.0-community
docker compose ps

Browser Shows Certificate Security Warning

Cause: The Community Edition uses a self-signed SSL certificate by default.

Solution: Click "Advanced" → "Proceed" in the browser. For production environments, a certificate issued by a proper CA is recommended (see the Enterprise Deployment Guide).

Next Steps

After installation is complete, you can:

Refer to Global Toolbar to learn basic interface operations
Refer to Navigation Menu to learn module navigation
Start using the Quick Start guide for initial setup

Prerequisites​

Runtime Environment​

Hardware Requirements​

Network Requirements​

Installation Steps​

1. Obtain the Installation Files​

2. Enter the Installation Directory​

3. Run the Installation Script​

4. Wait for Installation to Complete​

Access Huayang CMDB​

AI Assistant Model Configuration (Optional)​

Common Operations​

View Service Status​

View Logs​

Restart Services​

Stop Services​

Full Uninstall​

Frequently Asked Questions​

docker compose reports "no configuration file provided: not found"​

Browser Shows Certificate Security Warning​

Next Steps​