Video Full Demo, Installation & Client Automation
=======================================================================
ENTERPRISE CLOUDFLARE DNS MANAGER FOR WHMCS
=======================================================================
Version: 1.0
Author: MikyHost
Website: https://mikyhost.com
Support: https://mikyhost.com/submitticket.php
=======================================================================
Thank you for purchasing the Enterprise Cloudflare DNS Manager!
This module will empower your clients to manage their DNS, SSL, and
Security settings directly from your WHMCS Client Area.
Please read this installation guide carefully to ensure a smooth setup.
-----------------------------------------------------------------------
[1] MINIMUM SYSTEM REQUIREMENTS
-----------------------------------------------------------------------
- WHMCS Version: v7.10.x or higher (v9.x highly recommended)
- PHP Version: 7.2 or higher (Supports PHP 7.4, 8.1, 8.2 and 8.3)
- PHP Extensions: cURL
- Server: ionCube Loader installed and activated.
- Cloudflare: A standard Cloudflare account.
-----------------------------------------------------------------------
[2] UPLOADING THE FILES
-----------------------------------------------------------------------
1. Extract the downloaded ZIP file to your computer.
2. Connect to your WHMCS server via FTP or cPanel File Manager.
3. Upload the `cloudflare_dns` folder into your WHMCS addons directory:
PATH: /your_whmcs_directory/modules/addons/
(Ensure the folder structure looks like this:
/modules/addons/cloudflare_dns/cloudflare_dns.php)
-----------------------------------------------------------------------
[3] CLOUDFLARE API SETUP (VERY IMPORTANT)
-----------------------------------------------------------------------
To allow WHMCS to communicate with Cloudflare, you need your Account ID
and a properly configured API Token.
HOW TO GET YOUR ACCOUNT ID:
1. Log in to your Cloudflare Dashboard (dash.cloudflare.com).
2. Look at the URL in your browser. It looks like this:
dash.cloudflare.com/1234567890abcdef1234567890abcdef/
3. That long string of numbers and letters is your Account ID. Copy it.
HOW TO GENERATE THE CORRECT API TOKEN:
1. In Cloudflare, click the "Profile" icon (top right) > "My Profile".
2. On the left menu, click "API Tokens".
3. Click the blue "Create Token" button.
4. Scroll down to the bottom and click "Create Custom Token".
5. Name it something like "WHMCS DNS Module".
6. Under the "Permissions" section, you MUST add these 5 exact rules:
- Zone | DNS | Edit
- Zone | Zone | Edit
- Zone | Cache Purge | Purge
- Zone | Analytics | Read
- Zone | Zone Settings | Edit
7. Under "Account Resources", select: Include > All accounts.
8. Click "Continue to summary", then click "Create Token".
9. COPY THE API TOKEN. (Store it safely, Cloudflare will only show it once).
-----------------------------------------------------------------------
[4] ACTIVATING THE MODULE IN WHMCS
-----------------------------------------------------------------------
1. Log in to your WHMCS Admin Panel.
2. Navigate to Setup (Gear Icon) > System Settings > Addon Modules.
3. Find "Cloudflare DNS Manager" and click the green "Activate" button.
4. Once activated, click the "Configure" button on the same module.
5. Fill in the required fields:
- License Key: (Enter the license key provided by MikyHost)
- Cloudflare API Token: (Paste the Token you generated in Step 3)
- Cloudflare Account ID: (Paste the Account ID from Step 3)
6. Under "Access Control", check the box for "Full Administrator"
(or whichever admin roles you want to grant access to).
7. Click "Save Changes".
-----------------------------------------------------------------------
[5] AUTOMATION & EMAIL NOTIFICATIONS
-----------------------------------------------------------------------
- CRON AUTOMATION:
You DO NOT need to set up any new Cron Jobs on your server.
The module automatically hooks into your native WHMCS cron system.
It will check for DNS propagation every 5 minutes and prune old logs daily.
- WELCOME EMAIL:
Upon activation, the module automatically created an email template.
To customize the email sent to clients when their zone becomes active:
1. Go to WHMCS Admin > System Settings > Email Templates.
2. Select the "General Messages" tab.
3. Edit the template named: "Cloudflare Zone Activated".
-----------------------------------------------------------------------
[6] TROUBLESHOOTING
-----------------------------------------------------------------------
Q: Module says "License Invalid or Expired!"
A: Ensure your WHMCS domain and IP matches the ones registered in your
MikyHost Client Area. If you migrated your WHMCS, log in to MikyHost
and click "Reissue" on your license.
Q: Clients get "Unauthorized / Authentication Error" when clicking a button.
A: Your Cloudflare API Token is missing permissions. Please review STEP 3
and ensure ALL 5 permissions (DNS, Zone, Cache, Analytics, Settings)
are added to your Token.
Q: Why are clients stuck on "Pending Nameservers"?
A: DNS propagation takes time (usually 15 mins to 2 hours). The module
will automatically sync and turn it to "Active" in the background
once Cloudflare detects the new nameservers.
=======================================================================
Thank you for doing business with MikyHost!
If you have any questions or require custom development,
reach out to us at: https://mikyhost.com
=======================================================================
