IPFlow for WHMCS

Installation & License Activation Guide

This step-by-step guide walks you through installing, activating, configuring administrator permissions, and licensing IPFlow in your WHMCS installation.

Step 1: Download & Extract the Module Archive

  1. Log in to your client account at RoostKit and download the latest release archive (e.g., ipflow-v2.x.x.zip).
  2. Extract the ZIP file locally on your computer. Inside, you will find the modules/addons/ipflow/ directory containing the complete addon package.

Step 2: Upload Module Files to WHMCS

Upload the ipflow folder to your WHMCS server inside the addon modules directory:

/your-whmcs-root/modules/addons/ipflow/

Directory Structure Verification

Confirm that the following files are present in your WHMCS installation:

modules/addons/ipflow/
├── ipflow.php
├── hooks.php
├── routes.php
├── config/
├── lang/
├── assets/
└── src/

[!NOTE]
Ensure web server file permissions are set correctly (typically 755 for directories and 644 for files).

Step 3: Activate the Addon in WHMCS

  1. Log in to your WHMCS Admin Dashboard.
  2. Navigate to System Settings > Addon Modules (or Setup > Addon Modules in earlier WHMCS versions).
  3. Scroll through the list until you locate IPFlow.
  4. Click the green Activate button.
+-------------------------------------------------------------------------------+
| IPFlow                                                            [ Deactivate ]
| Automated IP Lifecycle Management & Subnet Allocation for WHMCS               |
| Version: 2.x | Author: RoostKit                                  [ Configure ] |
+-------------------------------------------------------------------------------+

Upon activation, IPFlow automatically initializes its database tables, indexes, and default settings in the background.

Step 4: Configure Administrator Permissions & Module Settings

  1. On the Addon Modules page, click the Configure button next to IPFlow.
  2. Configure the module options:
Setting Name Default Value Description
Maximum Subnet Size 4096 Maximum number of IP addresses allowed per subnet block (prevents accidental server memory overload).
Auto-Reserve Gateway Yes (Checked) Automatically reserves the gateway IP address (.1) during pool creation.
Auto-Reserve Network & Broadcast Yes (Checked) Automatically reserves the network boundary (.0) and broadcast address (.255) for IPv4 subnets.
Warning Threshold (%) 80 Utilization percentage at which an amber alert banner is displayed on the dashboard.
Critical Threshold (%) 95 Utilization percentage at which a critical red capacity alert is raised.
Preserve Data on Deactivation Yes (Checked) Keep checked! Ensures your subnets, IPs, and audit logs remain 100% safe if the addon is temporarily deactivated.
  1. Access Control: Scroll to the bottom of the popup and select the Administrator Role Groups that should have access to IPFlow (e.g. Full Administrator, Infrastructure Team, Support).
  2. Click Save Changes.

Step 5: Activate Your License Key

  1. Navigate to the IPFlow dashboard from your WHMCS top menu: Addons > IPFlow.
  2. Go to the Settings & Licensing tab.
  3. In the License Key field, paste the license key provided in your RoostKit purchase confirmation email.
  4. Click Activate License.
+-------------------------------------------------------------------------------+
|                           IPFlow License Status                               |
+-------------------------------------------------------------------------------+
| Status      : [ ACTIVE ] (Green Checkmark)                                    |
| License Key : ROOST-XXXX-XXXX-8F2C                                            |
| Expiry Date : 2027-08-20 (365 Days Remaining)                                 |
+-------------------------------------------------------------------------------+

Once activated, your license key is cached securely, and all IP provisioning and subnet management features become immediately available.

How to update IPFlow in Future Releases

Updating and applying any new version update to IPFlow is fast, non-destructive, and requires zero downtime:

  1. Download the new version archive from RoostKit.
  2. Upload and overwrite the files in /your-whmcs-root/modules/addons/ipflow/.
  3. Open Addons > IPFlow in your WHMCS admin area.
  4. IPFlow will automatically apply any required database improvements in the background without affecting your active IP assignments or customer services.

[!TIP]
Because Preserve Data on Deactivation is enabled by default, your customer IP bindings, subnet trees, and historical audit logs are never modified or removed during module upgrades.