How to download and install add-on module for WHMCS?

WHMCS Add-On Module Installation Guide

This guide will walk you through the steps to install an add-on module in WHMCS, ensuring that the module integrates smoothly into your system.

Prerequisites

  • Access to your WHMCS installation (admin panel and server).
  • The add-on module you want to install (usually provided as a .zip file).

Step 1: Download the Add-On Module

 

  • Log in to your Client Area.
  • Go to My Services.
  • Select the purchased product.
  • In the Download section, you’ll find the latest module zip file available for download.

 

Step 2: Upload the Add-On Module to Your Server

To install the module, you’ll first need to upload it to the modules directory on your WHMCS installation.

  1. Log in to your hosting server (via FTP, cPanel file manager, or SSH, depending on your access method).

  2. Navigate to your WHMCS root directory, typically located at:

    public_html/whmcs

  3. Inside the WHMCS root directory, go to the modules folder.

  4. Upload the add-on module (in .zip format) to the appropriate subfolder within modules. Typically, you’ll want to upload it to modules/addons/:

    public_html/whmcs/modules/addons/

    If you’re unsure of the subfolder, refer to the documentation provided with the add-on.

Step 3: Extract the Module (if needed)

  1. If you’ve uploaded a .zip file, you will need to extract it on the server. You can do this through the file manager in cPanel or using SSH.

  2. Extract the files into the corresponding folder inside modules/addons/.

    For example:

    public_html/whmcs/modules/addons/your-addon-name/

  3. After extraction, confirm that the module files are correctly placed within a folder named after the add-on.

Step 4: Activate the Module in WHMCS Admin Panel

Once the module is uploaded, it’s time to activate and configure it within the WHMCS admin panel.

  1. Log in to the WHMCS Admin Area: Navigate to your WHMCS admin panel (typically yourdomain.com/whmcs/admin).

  2. Go to "Setup" > "Addon Modules":

    • In the left-hand sidebar, hover over Setup and click on Addon Modules under the General Settings section.

  3. Locate the Installed Module:

    • In the list of available add-ons, find the newly uploaded module.

  4. Activate the Module:

    • Click the Activate button next to the module name to enable it within WHMCS.

Step 5: Configure the Module

  1. After activation, you may be prompted to configure the module.
  2. Click on the module name in the "Addon Modules" section to open the configuration page.
  3. Follow any specific configuration instructions provided by the add-on developer. Common configurations include API keys, product settings, or customization options.

 

Uninstalling the Add-On Module (If Needed)

If you need to uninstall the module, follow these steps:

  1. Log in to the WHMCS Admin Panel.
  2. Navigate to Setup > Addon Modules.
  3. Find the module you want to remove, then click the Deactivate button.
  4. Once deactivated, you can delete the module files from your server’s modules/addons/ directory.

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

Passkey-Based Authenticator Module for WHMCS - Documentation

Introduction The "Passkey-Based Authenticator Module for WHMCS" is designed to enhance the...

Product Page Module for WHMCS - Documentation

How to download the Product Page Module for WHMCS   Log in to your Client Area. Go to My...

Powered by WHMCompleteSolution