Personal tools
Namespaces

Variants
Actions

Proxmox Mail Gateway For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Configuration of Server)
(Configuration of Product)
Line 168: Line 168:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|The first section is dedicated to basic product configuration, select email type that will be used to create the service, provide all the required data:
+
|style="padding: 0px 0px 15px 15px;"|The only option is :D
 
+
* '''User Email''' - enable this option and the user email address will be used when creating the service
+
* '''Custom Email''' - if '' 'User Email' '' is disabled, the user will be generated in the VHI S3 panel based on the typed in here email address
+
* '''Panel Login URL''' - type in the web address of the Virtuozzo S3 panel. Clients will be redirected to this site when they press the '' 'Log in to Panel' '' button in your client area.<br/> Please remember to provide a valid HTTP protocol
+
* '''API Endpoint''' - enter the API endpoint that will be displayed in your client area
+
* '''API Documentation URL''' - type in the link to the API documentation, it will be visible in the client area as well
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_16_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_16_1.png]]
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Next move to setting the user limits, define the operations limit and bandwidth.<br/>
+
'''Operations Per Seconds'''
+
* '''Default [kilo ops/min]''' - in this field please enter the value that will be treated as a default one for operations limits.<br/> If provided, all unspecified operation limits will be set to this default value, otherwise they will be set to 0.
+
* '''DELETE [kilo ops/min]''' - enter the value for the DELETE operations limit
+
* '''GET [kilo ops/min]''' - enter the value for the GET operations limit
+
* '''PUT [kilo ops/min]''' - enter the value for the PUT operations limit
+
* '''LIST [kilo ops/min]''' - enter the value for the LIST operations limit <br/>
+
'''Bandwidth'''
+
* '''Out [Mb/s]''' - define an outgoing bandwidth limit
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_17.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|The next section is dedicated to quota management:
+
* '''User Quota [GB]''' - define the storage usage limit per user in gigabytes
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_18.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|In '' 'Admin Area Features' '' select options that will be visible under the product details:
+
* '''Last Month Usage Records''' - if enabled, the ' ''Last Month Usage Records' '' table will be available
+
* '''User Limits''' - show the '' 'User Limits' '' table
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:VHI_19.png]]
+
|}
+
 
+
{|
+
|style="padding: 0px 0px 15px 15px;"|Now, select which options you want to generate and confirm by clicking '' 'Create' ''.<br/> Note that the configuration for disabled options will still be taken from the configuration of the main product.<br/>More information about how to use configurable options can be found [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here] or in the official WHMCS [https://docs.whmcs.com/Addons_and_Configurable_Options documentation].
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:VHI_20.png]]
+
 
|}
 
|}
  

Revision as of 13:37, 7 February 2022

Contents

About Proxmox Mail Gateway For WHMCS

Proxmox Mail Gateway For WHMCS allows
  • Admin Area Features:
  • Client Area Features:
  • General Info:
✔ Supports WHMCS V8.0 And Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

This tutorial will show you how to successfully install and configure Payment Gateway Allocator For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to our client area and download the module.
PMG 1.png
2. Upload and extract the extension into the main WHMCS directory.

Extracted files in your WHMCS directory should look like this:

PMG 2.png
3. When you install Proxmox Mail Gateway For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in '/yourWHMCS/modules/servers/ProxmoxMailGateway/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

PMG 3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between the quotation marks as presented on the following screen.
You can find your license key in our client area → 'My Products'.

PMG 4.png
5. Now, set up the 'storage' folder as recursively writable.

This folder is available at '/yourWHMCS/modules/servers/ProxmoxMailGateway/'.

PMG 5.png

Configuration of Server

Server Configuration

10. Now, we will show you how to configure a new server.

To do so, log into your WHMCS and go to 'System Settings' 'Servers'.
Once you are there, press 'Add New Server'.

DA3 8.png
11. Next, enter your server name, IP address, username and password. Choose 'DirectadminExtended' from a dropdown menu and press 'Save Changes'.

In this section, you can also provide other server details like nameservers or the maximum number of accounts.
Note: Please remember that you can use login credentials of administrator or reseller account (reseller's login credentials can be used from the 3.3.0 version of the module).

DA3 9.png
12. After you configure your server correctly, you will see the following screen.

At this point, you need to create a new group for your server. For that purpose, press 'Create New Group'.

DA3 10.png
13. Enter the name, click on your previously created server, press 'Add' and then 'Save Changes'.
DA3 11.png

Configuration of Product

10. In order to create and configure a product, go to 'System Settings' 'Products/Services' 'Products/Services'.

Click on 'Create a New Group'.

VHI 11.png
11. Enter your product group name and press 'Save Changes'.
VHI 12.png
12. Once you have a product group, you can create a new product.

To do so, first click on 'Create a New Product'.

VHI 13.png
13. Afterward, choose your product type, enter your product name, choose module and the product group from the dropdown menus. Press 'Continue'.
VHI 14.png
14. Now, go to the 'Module Settings' section, choose your previously created server group from the dropdown menu.

If you did not set the proper permissions, you will be asked to do it now.

VHI 15.png
15. Now, let's start configuring the product settings.
VHI 16.png
The only option is :D
VHI 16 1.png

Management

In this section we will show you the possibilities

Settings

At th
PMG 9.png
In
File:PMG 9 1.png
File:PMG 9 2.png

Tips

1.

Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Proxmox Mail Gateway For WHMCS