Install

Installing the module is a matter of copying two folders into your WHMCS modules/ directory and pressing Activate once from the WHMCS admin. There is no build step, no Composer install, no runtime service to start, and nothing to configure on the panel side that is not already there. If you have SSH to your WHMCS host, the whole install takes under a minute. If you only have a File Manager or FTP client, allow five minutes for the upload.

This page covers the requirements, both installation paths (terminal and File Manager), the activation clicks, and how to verify afterwards that the module is loaded cleanly and ready for the Configure step.

Requirements

Before you download anything, confirm your environment meets the floors below.

Requirement	Minimum	Notes
WHMCS	8.0	Hard floor. Earlier releases ship an older Illuminate\Database\Capsule that lacks the updateOrInsert() method the module uses on its own tables. WHMCS 7.x will not work.
PHP	7.2	The module runs on PHP 7.2, 7.3, 7.4, 8.0, 8.1, 8.2 and 8.3. If your WHMCS runs on it, this module does.
PHP extensions	ext-curl, ext-json	Both ship enabled by default on every mainstream distribution. ext-mbstring is optional and only used for character length limits.
Database	MySQL or MariaDB	Whatever WHMCS itself is on. The module creates two of its own tables and uses no others.
Xtream AI Panel	2.1.2 or newer	Your panel operator must have PANEL_API_ENABLED=true set in the panel configuration. The Public API is the only channel the module speaks to the panel over.

If you do not know the version of a piece here, WHMCS reports its own version at Help → About WHMCS, PHP is on Utilities → System → PHP Info, and your panel version is visible to your panel admin under Settings.

If your WHMCS is still on 7.x, the module will error out at activation with a fatal on updateOrInsert(). Upgrade WHMCS first. There is no compatibility shim planned; the method the module needs is a WHMCS 8.0 addition.

Download the release

The current release is v1.0.0. Grab both the tarball and its SHA256 checksum from the Releases page on GitHub.

• whmcs-xtreamai-1.0.0.tar.gz (about 54 KiB).
• whmcs-xtreamai-1.0.0.tar.gz.sha256 (a text file with one line).

Verify the checksum before you install. The two extra seconds this takes save you from an entire class of "why is my install acting weird" investigations later on.

sha256sum -c whmcs-xtreamai-1.0.0.tar.gz.sha256

You should see whmcs-xtreamai-1.0.0.tar.gz: OK. If it prints FAILED, the file was corrupted in transit; download it again.

Extract it. The archive contains one top-level folder named whmcs-xtreamai/ with a modules/ directory inside.

tar -xzf whmcs-xtreamai-1.0.0.tar.gz

You now have whmcs-xtreamai/modules/servers/xtreamai/ and whmcs-xtreamai/modules/addons/xtreamai/. Those two folders are what you copy into WHMCS.

Install via terminal (recommended)

Use this path when you have SSH access to the WHMCS server. It is the fastest and the least error prone, and it makes upgrades a single cp -r in the future.

Replace /path/to/whmcs with the real path to your WHMCS root (the directory containing configuration.php, admin/, modules/ and the rest).

cp -r whmcs-xtreamai/modules/servers/xtreamai   /path/to/whmcs/modules/servers/
cp -r whmcs-xtreamai/modules/addons/xtreamai    /path/to/whmcs/modules/addons/

Ownership matters. The two folders must belong to the user that runs your PHP-FPM pool (or your Apache mod_php), otherwise WHMCS will not be able to write into its own working directories the module inherits. Adjust the ownership to match the rest of modules/, then lock the file mode to 0644 for files and 0755 for directories.

chown -R $(stat -c '%U:%G' /path/to/whmcs/modules/servers) \
    /path/to/whmcs/modules/servers/xtreamai \
    /path/to/whmcs/modules/addons/xtreamai
find /path/to/whmcs/modules/servers/xtreamai /path/to/whmcs/modules/addons/xtreamai -type f -exec chmod 0644 {} \;
find /path/to/whmcs/modules/servers/xtreamai /path/to/whmcs/modules/addons/xtreamai -type d -exec chmod 0755 {} \;

The stat -c '%U:%G' snippet picks up the owner of the existing modules/servers directory, which is the correct target on every WHMCS install we have seen. If you prefer to be explicit, use the exact username your PHP process runs as.

Install via File Manager or FTP

Use this path when you host WHMCS on cPanel, Plesk, DirectAdmin, or any shared environment where SSH is not available. The end result is identical; only the tool changes.

1. Extract the tarball on your laptop, so you end up with the whmcs-xtreamai/modules/ tree on your local disk.
2. Open your host's File Manager, or connect with an FTP client such as FileZilla.
3. Navigate to your WHMCS root and then into modules/.
4. Upload the xtreamai folder from your local modules/servers/ into the WHMCS modules/servers/ directory on the server.
5. Upload the xtreamai folder from your local modules/addons/ into the WHMCS modules/addons/ directory on the server.

Both folders together weigh under 200 KiB, so even the slowest connection finishes the upload in seconds.

Some File Managers on shared hosts have an "Extract Archive" action that will happily extract a tarball server-side. If yours does, you can upload the whole whmcs-xtreamai-1.0.0.tar.gz and extract it in place, then move the two xtreamai folders into modules/servers/ and modules/addons/. The end state is the same.

Verify the two folders landed correctly

Regardless of how you copied the files across, the sanity check is the same: verify that two known files exist. If both are readable by your PHP process, the module will load.

test -f /path/to/whmcs/modules/servers/xtreamai/xtreamai.php && echo "server module OK"
test -f /path/to/whmcs/modules/addons/xtreamai/xtreamai.php  && echo "addon module OK"

Both lines should print. In File Manager, navigate to those two paths and confirm the .php files are visible with a non-zero size.

Activate the addon

Log in to your WHMCS admin as a user with permission to manage system settings. Go to System Settings → Addon Modules (older layouts call it Setup → Addon Modules).

Find Xtream AI Panel in the list and click Activate.

On a successful activation WHMCS shows a green flash reading Xtream AI Panel activated. Open the module and add a panel.

Two things happen behind the scenes at activation. First, the module creates its own tables (mod_xtreamai_panels, mod_xtreamai_services, mod_xtreamai_settings) if they do not already exist. Second, the addon becomes reachable at Addons → Xtream AI Panel in the top menu.

If Activate throws an error like Call to undefined method Illuminate\Database\Capsule\Manager::updateOrInsert(), your WHMCS is 7.x. See the Requirements section above. Upgrade WHMCS to 8.0 or newer and try again.

Give admin access to the module

WHMCS's addon permissions are opt-in per admin role, so a fresh activation does not grant access to anyone automatically. Even the superadmin account may not see the sidebar entry until the role is ticked.

1. Go back to System Settings → Addon Modules.
2. Click Configure next to Xtream AI Panel.
3. In the Access Control section, tick every admin role that should be able to open the addon.
4. Save.

Where to go next

The module is installed and activated but not yet configured. The next page walks through obtaining your Panel API key, adding your panel to the addon, and creating a WHMCS product that provisions through the module.

• Configure. Three-step configuration: API key, panel entry, product.