Mikrotik WireGuard VPN WHMCS module

The module is intended as an opportunity for IT companies to expand their offer for customers by offering paid WireGuard VPN accounts. After installation, the module will fully manage the creation, edition, and suspension of WireGuard VPN accounts and interact with the WHMCS billing system, exchanging data needed for settlements with customers, activations or service blocking. Initial assumptions: the company uses WHMCS and owns or is able to install Mikrotik routers. Mikrotik routers are necessary to provide VPN service. WHMCS is necessary to manage the WireGuard VPN service.

• Changelog
• Description
• Installation and configuration guide
• WHMCS setup(install/update)
• Setup guide: Mikrotik preparation and configuration
• Add server (router Mikrotik) in WHMCS
• Product Configuration in WHMCS
• Client Area
• Home screen
• Admin Area
• Product Information

Changelog

Mikrotik WireGuard VPN module WHMCS 

 Order now | Download | FAQ

v2.0 Released 23-09-2024

Module is coded ionCube v13

Supported php version:

• php 7.4 WHMCS 8.11.0 -
• php 8.1 WHMCS 8.11.0 +
• php 8.2 WHMCS 8.11.0 +

---

v1.3 Released 29-07-2024

1. Add metric pricing for incoming/outgoing traffic

---

v1.2 Released 17-06-2024

1. Added VPN interface reboot function (to reset a frozen connection)
2.  Improved adaptation to the mobile version of the client area
3. Some changes in translations

---

v1.1 Released 15-12-2023

1.  Added functionality for changing packages
2.  Minor changes to the admin/client interface

---

v1.0 Released 09-10-2023

First version

Description

Mikrotik WireGuard VPN module WHMCS 

 Order now | Download | FAQ

The module, fully installed and correctly implemented in the system, offers the following functionalities.

Module Functions:

• Auto create and deploy WireGuard VPN account
• Suspend/Unsuspend/Terminate
• Use only Mikrotik API
• Possibility to set Bandwidth speed limits
• Module supports multilingualism (Arabic, Azerbaijani, Catalan, Chinese, Croatian, Czech, Danish, Dutch, English, Estonian, Farsi, French, German, Hebrew, Hungarian, Italian, Macedonian, Norwegian, Polish, Romanian, Russian, Spanish, Swedish, Turkish, Ukrainian)
• Link to instructions for setting up the service in the client area.
• Link to VPN clients for setting up the service in the client area.
• In the WHMCS settings, a list of IPs is specified for use by clients.
• Ability to use both private and public IPs for clients

Available options in the admin panel:

• Create users
• Suspend users
• Terminate users
• Unsuspend users
• Change package
• VPN connection status
• VPN interface reboot function (to reset a frozen connection)
• Text and QR code configuration types
• Metric Billing  (Bandwidth Usage In/Out)

Available options in the client panel:

• VPN connection status
• Text and QR code configuration types
• VPN interface reboot function (to reset a frozen connection)

---

WHMCS minimal version: 8 +

Mikrotik minimal version: 7 +

The settings of the whmcs module when it comes to upload and download speeds register the opposite values in the mikrotik router (e.g. download speed in whmcs 1mb = upload speed in mikrotirk 1mb). This is due to the fact that from the point of view of Mikrotik, the traffic is incoming, and from the point of view of the VPN client, this is outgoing traffic.

Please be aware that to ensure proper functionality of VPN connections, it is essential for you, as an administrator, to correctly configure the Mikrotik router. This entails configuring NAT, Firewall, routing, and all the required settings for VPN to operate correctly on your router.

 

 

Installation and configuration guide

WHMCS setup(install/update)

Mikrotik WireGuard VPN module WHMCS 

 Order now | Download | FAQ

Module is coded ionCube v13

Supported php version:

• php 7.4 WHMCS 8.11.0 -
• php 8.1 WHMCS 8.11.0 +
• php 8.2 WHMCS 8.11.0 +

To install and update a module, you must perform one and the same action.

1. Download the latest version of the module.

PHP 8.2

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Mikrotik-WireGuard-VPN/php82/PUQ_WHMCS-Mikrotik-WireGuard-VPN-latest.zip

PHP 8.1

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Mikrotik-WireGuard-VPN/php81/PUQ_WHMCS-Mikrotik-WireGuard-VPN-latest.zip

PHP 7.4

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Mikrotik-WireGuard-VPN/php74/PUQ_WHMCS-Mikrotik-WireGuard-VPN-latest.zip

 

All versions are available via link: http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-Mikrotik-WireGuard-VPN/

2. Unzip the archive with the module.

unzip PUQ_WHMCS-Mikrotik-WireGuard-VPN-latest.zip

3. Copy and Replace "puqMikrotikWireGuardVPN" to "WHMCS_WEB_DIR/modules/servers/"

 

Setup guide: Mikrotik preparation and configuration

Mikrotik WireGuard VPN module WHMCS 

 Order now | Download | FAQ

Note: Enter the following commands one by one and wait for the command to complete.

I. Check RouterOS version

Make sure that the version of RouterOS is 7+

system/package/print 

 

II. Enabling HTTPS Create your own root CA on your router

/certificate
add name=LocalCA common-name=LocalCA key-usage=key-cert-sign,crl-sign

 

III. Sign the newly created CA certificate

/certificate
sign LocalCA

 

IV. Create a new certificate for Webfig (non-root certificate)

Note: as common-name=XXX.XXX.XXX.XXX You enter public IP adddress of the router.

/certificate
add name=Webfig common-name=XXX.XXX.XXX.XXX

 

V. Sign the newly created certificate for Webfig

/certificate
sign Webfig ca=LocalCA 

 

VI. Enable SSL (www-ssl) and specify to use the newly created certificate for Webfig

/ip service
set www-ssl certificate=Webfig disabled=no

 

VII. Enable api-ssl and specify to use the newly created certificate for Webfig

 /ip service 
 set api-ssl certificate=Webfig disabled=no 

 

VIII. Creating a WireGuard Server

To enable the WireGuard VPN server

 

Add server (router Mikrotik) in WHMCS

Mikrotik WireGuard VPN module WHMCS 

 Order now | Download | FAQ

Add a new server to the system WHMCS.

System Settings->Servers->Add New Server

• Enter the correct Name and Hostname

Name is just for Your convenience and You can put there anything You like ie: Mygreat mikrotik routr

You can choose whatever hostname You want. Valid entries look similar to: vpn.mydomain.com, ourgreatvpn.mydomain.net. You can also dedicate whole domain ie: myVPNservices.com if You like. The important  thing is to resolve the choosen IP address of the Mikrotik router in DNS server for Your domain.

• In the "Assigned IP Addresses field", enter a list of IP addresses that will be issued to users.

 

• In the Server Details section, select the "PUQ Mikrotik WireGuard VPN" module and enter the correct username and password for the Mikrotik router.
• To check, click the "Test connection" button

 

Product Configuration in WHMCS

Mikrotik WireGuard VPN module WHMCS 

 Order now | Download | FAQ

Add new product to WHMCS

System Settings->Products/Services->Create a New Product

In the Module settings section, select the "PUQ Mikrotik WireGuard VPN" module

• License key: A pre-purchased license key for the "PUQ Mikrotik WireGuard VPN" module. For the module to work correctly, the key must be active
• WireGuard interface: A pre-created WireGuard server on a Mikrotik router, which will serve as peers for clients of this service.
• Comment PREFIX: The prefix that will be added to the VPN user's comment on the Mikrotik router
• Bandwidth Download: Download Bandwidth Limit in M/s
• Bandwidth Upload:  Upload Bandwidth Limit M/s
• DNS Servers: Option in WireGuard client configuration
• AllowedIPs: Option in WireGuard client configuration
• Persistent Keepalive: Option in WireGuard client configuration
• Link to instruction: Link to the instruction, if filled out, it will be reflected in the client area
• Link to VPN clients: The URL that will be shown to the client in the client panel in order to download the VPN client

 

Metric Billing

It is also possible to set up tariffs for incoming and outgoing traffic.
Standard methods for setting up metrics

Bandwidth Usage In 

Bandwidth Usage Out

 

Client Area

Home screen

Mikrotik WireGuard VPN module WHMCS 

 Order now | Download | FAQ

The end customer, after logging in to his own customer panel, has access to the following information and options:

• Link to the user manual (which was defined by the administrator when setting up the service.).
• Link to the VPN clients (which was defined by the administrator when setting up the service.).
• Information about available VPN protocols and statuses
• Button to download WireGuard client configuration
• VPN WireGuard clinet configuration text and QR-code
• VPN interface reboot function (to reset a frozen connection)

 

Admin Area

Product Information

Mikrotik WireGuard VPN module WHMCS 

 Order now | Download | FAQ

Product Information Screen