Personal tools
Namespaces

Variants
Actions

MikroTik WireGuard VPN For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 205: Line 205:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/mikrotik-wireguard-vpn#open-source-version Open Source Version]
 
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/mikrotik-wireguard-vpn#open-source-version Open Source Version]
−
|}
 
−
 
−
<!--
 
−
==Installation and Configuration==
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|
 
−
This tutorial will show you how to successfully install and configure '''MikroTik WireGuard VPN For WHMCS'''.<br/>
 
−
We will guide you step by step through the installation process, MikroTik server connection, product configuration, metric billing setup, addon module management, and client area features.
 
−
|}
 
−
 
−
===Installation===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'''1. Extract the module package into the main WHMCS directory.'''<br/>
 
−
The files should be uploaded into the corresponding WHMCS folders.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MTWG_1.png]]
 
−
|}
 
−
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'''2. Log in to your WHMCS admin area and navigate to ''System Settings'' → ''Addon Modules''.'''<br/>
 
−
Find ''MikroTik WireGuard VPN'' on the list and click ''Activate''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MTWG_2.png]]
 
−
|}
 
−
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'''3. Set access permissions for the required administrator roles and save the changes.'''<br/>
 
−
The addon module can now be opened through ''Addons'' → ''MikroTik WireGuard VPN''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MTWG_3.png]]
 
−
|}
 
−
 
−
===MikroTik Router Preparation===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|
 
−
Before connecting the router to WHMCS, make sure that:
 
−
 
−
* MikroTik RouterOS '''7.20 or later''' is installed.
 
−
* A WireGuard interface has been created on the router.
 
−
* The RouterOS REST API is available.
 
−
* The API user has permissions sufficient to manage WireGuard peers, addresses, queues, and traffic data required by the module.
 
−
* The selected HTTP or HTTPS service and port are accessible from the WHMCS server.
 
−
* When a secure connection is used, HTTPS and a valid router certificate are configured correctly.
 
−
 
−
<div class="box">
 
−
'''Important:''' Restrict API access to trusted IP addresses whenever possible and use HTTPS for production environments.
 
−
</div>
 
 
|}
 
|}
  
Line 260: Line 210:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''4. Navigate to ''System Settings'' → ''Servers'' and click ''Add New Server''.'''<br/>
 
|style="padding: 10px 0px 15px 15px;"|'''4. Navigate to ''System Settings'' → ''Servers'' and click ''Add New Server''.'''<br/>
−
Choose ''MikroTik WireGuard VPN'' from the ''Module'' dropdown menu and provide the router connection details.
+
Choose ''MikroTik WireGuard VPN'' from the ''Module'' dropdown menu and provide the router connection details.<br/>
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:MTWG_4.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|
+
 
Configure the following fields:
 
Configure the following fields:
  
Line 276: Line 220:
 
* '''Secure''' – enable to connect through HTTPS.
 
* '''Secure''' – enable to connect through HTTPS.
 
* '''IP Address Pool''' – define the tunnel IP address range used to assign addresses to new VPN peers.
 
* '''IP Address Pool''' – define the tunnel IP address range used to assign addresses to new VPN peers.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MTWG_4.png]]
 
|}
 
|}
 
{|
 
{|
Line 281: Line 228:
 
If the test is successful, save the server configuration.
 
If the test is successful, save the server configuration.
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:MTWG_5.png]]
 
−
|}
 
−
 
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'''6. Create or select a server group and assign the configured MikroTik server to it.'''<br/>
 
|style="padding: 10px 0px 15px 15px;"|'''6. Create or select a server group and assign the configured MikroTik server to it.'''<br/>
−
The server group can later be selected in the product's module settings. Multiple routers may be added to support a larger VPN infrastructure.
+
The server group can later be selected in the product's module settings.
−
|}
+
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:MTWG_6.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:MTWG_6.png]]
 
|}
 
|}
  
 +
<!--
 
===Product Configuration===
 
===Product Configuration===
 
{|
 
{|

Revision as of 15:34, 30 July 2026

This documentation is still being prepared. Please allow us a little more time to polish and publish the complete article.
Thank you for your patience!



About MikroTik WireGuard VPN For WHMCS

MikroTik WireGuard VPN For WHMCS enables automated provisioning and management of WireGuard VPN services on MikroTik routers.

The module creates VPN peers, assigns tunnel IP addresses, applies bandwidth limits, and tracks traffic usage directly through WHMCS.
Clients can access their connection details, scan a configuration QR code, download a ready-to-use configuration file, and review traffic statistics in the client area.

  • Core Features:
✔ Automate Complete WireGuard VPN Service Provisioning
✔ Manage VPN Accounts On MikroTik Routers Through WHMCS
✔ Control Bandwidth And Track Traffic Usage
✔ Provide Clients With Ready-To-Use VPN Configurations
✔ Support Usage-Based Billing For Transferred Traffic
  • Admin Area:
✔ Create, Suspend, Unsuspend And Terminate VPN Accounts
✔ Change Service Packages
✔ View Peer And Connection Details
✔ Download VPN Configuration Files
✔ View Daily And Monthly Traffic Statistics
✔ Reset VPN Connections
✔ Configure Products:
✔ Select MikroTik Server And WireGuard Interface
✔ Define Peer Comment Prefix
✔ Configure Allowed IP Addresses And DNS Servers
✔ Set Keepalive Interval
✔ Define Upload And Download Speed Limits
✔ Enable Traffic Statistics
✔ Configure Traffic Data Retention Period
✔ Define Setup Guide And WireGuard Client Download URLs
✔ Enable Usage-Based Metric Billing
  • Addon Module:
✔ View Dashboard With Server, Account And Service Summaries
✔ View General Traffic Overview Graph
✔ Manage Multiple MikroTik Servers
✔ View All WireGuard VPN Accounts And Peers
✔ Preview Peer State, Interface, Last Handshake And Traffic Usage
✔ View Connection Details And Configuration
✔ Control Staff Access Level To Specific Resources With ACL
✔ Customize Module Language Files With "Translations" Tool
✔ Review Module Activity And Error Logs
  • Client Area:
✔ View VPN Account And Connection Status
✔ View Connection Details And Assigned Tunnel IP Address
✔ Check Applied Bandwidth Limits
✔ Preview WireGuard Configuration
✔ Scan Configuration QR Code
✔ Download Ready-To-Use .conf File
✔ View Daily And Monthly Traffic Statistics
✔ Reset VPN Connection
✔ Access Setup Guide
✔ Download WireGuard Client
  • General Info:
✔ Supports MikroTik RouterOS 7.20 And Later
✔ Supports Multiple MikroTik Routers
✔ Multi-Language Support With Custom Translations Tool
✔ Supports PHP 8.3 Back To PHP 8.2
✔ Supports WHMCS Themes "Six", "Twenty-One", "Nexus" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V9.X
✔ Requires ionCube Loader V14 Or Later
✔ Easy Module Upgrade To Open Source Version

Server Configuration

4. Navigate to System Settings → Servers and click Add New Server.

Choose MikroTik WireGuard VPN from the Module dropdown menu and provide the router connection details.
Configure the following fields:

  • Name – enter a descriptive server name.
  • Hostname – provide the router hostname or IP address.
  • Username – enter the RouterOS API username.
  • Password – enter the password assigned to the API user.
  • Port – provide the port used by the RouterOS REST API.
  • Secure – enable to connect through HTTPS.
  • IP Address Pool – define the tunnel IP address range used to assign addresses to new VPN peers.
MTWG 4.png
5. Use Test Connection to verify the provided credentials and connection settings.

If the test is successful, save the server configuration.

6. Create or select a server group and assign the configured MikroTik server to it.

The server group can later be selected in the product's module settings.

MTWG 6.png


Retrieved from "https://www.docs.modulesgarden.com/index.php?title=MikroTik_WireGuard_VPN_For_WHMCS&oldid=80324"
Navigation
WHMCS Modules
WHMCS Module Bundles
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community