Installation

Follow these steps to install the AI KB Generator addon in your WHMCS installation.


Prerequisites

Before installing, ensure you have:

  • WHMCS 8.0 or higher installed
  • PHP 7.4 or higher
  • cURL extension enabled
  • A Deploymance license key (get one at deploymance.com)
  • A Google Gemini API key (free at aistudio.google.com)

Step 1: Download the Addon

Download the latest version of AI KB Generator from your account dashboard or the GitHub releases page.

Step 2: Upload Files

Extract the downloaded archive and upload the ai_kb_generator folder to your WHMCS installation:

# Upload to:

/path/to/whmcs/modules/addons/ai_kb_generator/

The folder structure should look like this:

modules/

addons/

ai_kb_generator/

├── ai_kb_generator.php

├── hooks.php

├── lib/

│ ├── Admin/

│ └── Services/

├── LICENSE

└── README.md

Step 3: Activate the Addon

  1. Log in to your WHMCS Admin Area
  2. Navigate to System Settings → Addon Modules
  3. Find "AI KB Generator" in the list
  4. Click "Activate"

Step 4: Configure the Addon

  1. After activation, click "Configure"
  2. Enter your Deploymance License Key
  3. Enter your Google Gemini API Key
  4. Configure optional settings (model, retention days, etc.)
  5. Set access control to specify which admin roles can use the addon
  6. Click "Save Changes"

See the Configuration Guide for detailed settings information.

Step 5: Verify Installation

To verify the installation was successful:

  1. Navigate to Addons → AI KB Generator in the admin menu
  2. You should see the KB Generator dashboard with the ticket queue
  3. Open any support ticket and look for the "Create KB Article" button

Troubleshooting

Addon not showing in the list?

Ensure the folder is named exactly ai_kb_generator and is placed in the correct directory.

License validation failed?

Make sure your license key is correct and your WHMCS domain matches the domain registered with your license.

cURL errors?

Ensure your server has outbound HTTPS access and the cURL extension is enabled in PHP.