CHAI™
Install and configure the CHAI™ Appliance via the CHCTL command-line utility
1. System Requirements
Ensure the target machine meets all of the following requirements before beginning the installation.
1.1 Operating System Requirements
| Operating System | Supported Version |
|---|---|
| Ubuntu | 16 or higher |
| RHEL | 7.6 or higher, 8.x |
1.2 Hardware Resource Requirements
| Resource | CPU | RAM |
|---|---|---|
| Minimum Requirement | 4 cores | 16 GB |
Disk Space: 50 GB at /opt (target directory) and 100 GB for the /var partition.
2. Prerequisites
Confirm all of the following are in place before proceeding:
| Requirement | Details |
|---|---|
| Linux user privileges | Must have permission to execute installation commands |
| SELinux | Must be disabled — verify with sestatus |
| Docker | Installed and running — verify with docker --version |
| Docker Compose | Installed and running — verify with docker compose version |
| Disk space | 50 GB at /opt, 100 GB at /var |
Verify Docker and Docker Compose are operational:
docker --version
docker compose version
3. Installation Process
Step 1 — Download Installation Package
Download the singlefile.tar.gz installation package from AWS S3 using the signed URL provided by the CHAI™ team. This URL is time-bound — use it promptly. You can download via browser or using wget:
wget '<Provided-URL>' -O 'singlefile.tar.gz'
Step 2 — Extract Installation Files
Extract the contents of the downloaded archive:
tar -xvzf singlefile.tar.gz
Verify the extraction by listing the directory contents — the required files should all be present:
ls -ltr
Step 3 — Configure CHCTL Binary
Move the CHCTL binary (chctl_linux) to /bin/chctl and make it executable:
sudo mv chctl_linux /bin/chctl && chmod +x /bin/chctl
Confirm the installation by checking the version:
chctl --version
Step 4 — Setup CHAI™ Appliance
Run the setup command to install the CHAI™ appliance:
sudo chctl setup appliance
By default this installs to /opt/appliance. To use a different path, pass the --targetdirectory flag.
The setup command performs the following operations in sequence:
- Verifies Docker and Docker Compose are present and running
- Creates the required directory structure
- Loads necessary Docker containers into memory
- Initialises the database and seeds it with required data
--skip-load-container to skip container loading if containers are already loaded. Use --skip-db-setup to skip database initialisation if already configured.
Step 5 — Start the Appliance
Once setup completes successfully, start the CHAI™ appliance:
sudo chctl start appliance
Step 6 — Verify Installation
Confirm the appliance is running correctly:
sudo chctl status appliance
4. Post-Installation Configuration
Access the CHAI™ application in Google Chrome by navigating to:
https://<ip_or_dns_of_the_machine>
Use the default credentials below for initial login. You will be prompted to change the password on first login.
| Field | Value |
|---|---|
| Default Username | onprem@cloudhedge.io |
| Default Password | chdevrocks (change on first login) |
4.1 Configure App Host URL
After logging in, navigate to Settings → Configuration → App Host. Paste the URL you used to access the appliance and click Save URL.
5. Essential CHCTL Commands Reference
| Command | Description |
|---|---|
sudo chctl setup appliance | Install and initialise the appliance |
sudo chctl start appliance | Start the appliance |
sudo chctl stop appliance | Stop the appliance |
sudo chctl status appliance | Check appliance status |
sudo chctl patch appliance | Apply a fix to a specific service |