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.

This tutorial will show you how to successfully install and configure MikroTik WireGuard VPN For WHMCS.
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.

The files should be uploaded into the corresponding WHMCS folders.

Find MikroTik WireGuard VPN on the list and click Activate.

The addon module can now be opened through Addons → MikroTik WireGuard VPN.

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.

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.

If the test is successful, save the server configuration.

The server group can later be selected in the product's module settings. Multiple routers may be added to support a larger VPN infrastructure.

Open the Module Settings tab and select MikroTik WireGuard VPN as the module.

The available settings include:

• Server Group – select the group containing the MikroTik router that will host the VPN peer.
• WireGuard Interface – select or enter the WireGuard interface used for the service.
• Comment Prefix – define the prefix added to comments identifying module-created peers.
• Allowed IPs – specify the addresses or networks routed through the VPN tunnel.
• DNS Servers – define the DNS servers included in the client configuration.
• Persistent Keepalive – set the keepalive interval in seconds.
• Upload Speed Limit – define the maximum upload speed assigned to the service.
• Download Speed Limit – define the maximum download speed assigned to the service.
• Traffic Statistics – enable traffic data collection and presentation.
• Traffic Data Retention Period – define how long collected traffic records should be stored.
• Setup Guide URL – provide a link to your VPN setup instructions.
• WireGuard Client Download URL – provide a link clients can use to download the WireGuard application.
• Usage-Based Metric Billing – enable reporting of download and upload usage to WHMCS metric billing.

Depending on the selected WHMCS option, the VPN account may be created automatically after the first payment, immediately after order placement, or manually by an administrator.

The addon module provides a centralized overview of MikroTik servers, WireGuard accounts, traffic, and module activity.
Navigate to Addons → MikroTik WireGuard VPN to open it.

Use the summary widgets to review servers, VPN accounts, and WHMCS services. The traffic overview graph presents the general amount of data transferred during the selected period.

For each entry, you can review its name, hostname, connection port, secure connection status, assigned services, and current availability.

Use search and filters to locate a specific account or narrow the list by server and current state.

The list may include:

• related WHMCS service and client
• assigned MikroTik server
• WireGuard interface
• peer state
• last handshake
• uploaded and downloaded traffic

Use it to review performed actions and diagnose provisioning or communication problems. Search and filtering options help locate relevant entries.

Select a language, locate the required phrase, provide its custom translation, and save the changes.

Grant only the permissions required by each staff group and save the configuration.

Open a client's product or service in the WHMCS admin area to manage the related WireGuard VPN account.

Administrators can also perform the standard module commands:

• Create
• Suspend
• Unsuspend
• Terminate
• Change Package

Switch between daily and monthly views to analyze usage over the required period.

Administrators can preview the generated configuration or download it as a ready-to-use .conf file.

The client area gives customers direct access to their WireGuard VPN service and the resources required to configure a connection.

Depending on the product configuration, clients can also open the setup guide and download the WireGuard application.

Available client actions include:

• previewing the WireGuard configuration
• scanning the configuration QR code
• downloading the ready-to-use .conf file
• resetting the VPN connection
• opening the setup guide
• downloading the WireGuard client

The same configuration can be downloaded as a .conf file.

Statistics can be displayed in daily or monthly intervals.

The client must confirm the action before it is performed.

The module requires the WHMCS cron to run correctly for automated service operations, traffic collection, metric usage reporting, and data maintenance.
Make sure that the main WHMCS automation cron is configured according to the official WHMCS documentation.

An essential guidance through the module update process can be found here.

• Verify the router hostname or IP address and REST API port.
• Make sure the selected HTTP or HTTPS service is enabled and reachable from the WHMCS server.
• Confirm the API username, password, and assigned RouterOS permissions.
• If Secure is enabled, verify the router certificate and HTTPS configuration.

• Make sure the selected WireGuard interface exists on the target router.
• Check whether the configured tunnel IP address pool contains an available address.
• Review the module logs for the exact RouterOS API response.
• Verify that the API user can manage the resources required by the module.

• Confirm that traffic statistics are enabled in the product's module settings.
• Make sure the WHMCS cron is running correctly.
• Allow the module enough time to collect the first traffic records.
• Review the module logs for traffic collection errors.

• Enable usage-based metric billing in the product's module settings.
• Configure pricing for the Download (GB) and Upload (GB) metrics in WHMCS.
• Confirm that traffic usage is being collected and reported.
• Verify that the WHMCS automation cron is running.