Skip to main content
Version: 1.x

Community Edition Deployment Guide

This document describes how to quickly deploy the Huayang CMDB Community Edition. The community edition is suitable for product evaluation, feature assessment, and training demonstration scenarios.

Prerequisites​

Runtime Environment​

  • Operating System: Linux (64-bit). Ubuntu 22.04 / 24.04 LTS is recommended. Other Linux distributions that support 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​

ComponentMinimumRecommended
CPU4 cores8 cores or more
Memory8 GB16 GB or more
Disk100 GB SSD200 GB or more SSD

Network Requirements​

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

Installation Steps​

1. Extract the Installation Package​

tar -zxvf hyo-cmdb-1.0.0.tar.gz

2. Enter the Extracted Directory​

cd hyo-cmdb-1.0.0

3. Run the Installation Script​

sudo ./scripts/install.sh <host_FQDN>

Parameter Description: <host_FQDN> is the fully qualified domain name of the host.

This application must be accessed via a domain name, not an IP address. Choose one of the following methods to configure:

Option 1: Real Domain Name

Point your domain's DNS resolution to the installation machine's IP, and pass the domain name during installation (e.g., app.yourcompany.com).

Option 2: Modify Hosts File

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

<machine_IP>   <custom_domain>

Example: 192.168.1.100 mydemo.local

  • Linux/macOS: Edit /etc/hosts
  • Windows: Edit C:\Windows\System32\drivers\etc\hosts

Pass the custom domain name during installation (e.g., mydemo.local), then access via https://mydemo.local:4443/....

4. Wait for Installation to Complete​

The installation script automatically performs the following operations:

  • Loads images into the local registry
  • Generates SSL certificates (if not present)
  • Starts all service containers

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

Access Huayang CMDB​

After installation is complete, access via browser:

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

Common Operations​

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

View Service Status​

docker compose ps

View Logs​

# View all service logs
docker compose logs -f

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

Restart Services​

docker compose restart

Stop Services​

docker compose down

Complete Uninstall​

Warning

This operation deletes all data and is irreversible.

docker compose down -v

Frequently Asked Questions​

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

Cause: docker compose must be executed in the directory containing 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 executing commands:

cd hyo-cmdb-1.0.0
docker compose ps

Browser Shows Certificate Security Warning​

Cause: The community edition uses a self-signed SSL certificate by default.

Solution: Click "Advanced" → "Continue to site" in the browser. For production environments, use certificates issued by a proper CA.

Next Steps​

After installation is complete, you can: