Personal tools
Namespaces

Variants
Actions

Proxmox Mail Gateway For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Installation)
(→‎Tips)
(38 intermediate revisions by one user not shown)
Line 1: Line 1:
−
<meta name="keywords" content="payment gateway allocator for whmcs, payment gateway allocator configuration, whmcs payment gateway allocator management, whmcs payment gateway allocator installation, whmcs payment gateway allocator common problems, about whmcs payment gateway allocator, whmcs payment gateway allocator documentation, whmcs payment gateway allocator faq, whmcs payment gateway allocator help, whmcs payment gateway allocator guide, whmcs payment gateway allocator wiki, whmcs payment gateway allocator tutorial, whmcs payment gateway allocator tips, whmcs payment gateway allocator wiki"></meta>
+
<meta name="keywords" content="proxmox mail gateway for whmcs,proxmox mail gateway configuration, whmcs proxmox mail gateway management, whmcs proxmox mail gateway installation, whmcs proxmox mail gateway common problems, about whmcs proxmox mail gateway, whmcs proxmox mail gateway documentation, whmcs proxmox mail gateway faq, whmcs proxmox mail gateway help, whmcs proxmox mail gateway guide, whmcs proxmox mail gateway wiki, whmcs proxmox mail gateway tutorial, whmcs proxmox mail gateway tips, whmcs proxmox mail gateway wiki"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Payment Gateway Allocator For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Proxmox Mail Gateway For WHMCS Module."></meta>
  
−
=About [https://www.modulesgarden.com/products/whmcs/payment-gateway-allocator Proxmox Mail Gateway For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/proxmox-mail-gateway Proxmox Mail Gateway For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Proxmox Mail Gateway For WHMCS''' allows  
+
|style="padding: 10px 0px 10px 0px;"|'''Proxmox Mail Gateway For WHMCS''' is a modern security tool that assures protection to mail servers from any kind of threats.<br/>
 +
The module allows to perform the core management actions on the Proxmox Mail Gateway services directly from your WHMCS, from both the admin and the client side.<br/>
 
|}
 
|}
 
<!-- This is a comment -->
 
<!-- This is a comment -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Service
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ View/Edit Service Configuration:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔
+
|style="padding: 0px 0px 0px 45px;"|✔ Domain Name
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 45px;"|✔ Transport Host/Port/Protocol
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔
+
|style="padding: 0px 0px 0px 45px;"|✔ MX Usage Status
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Configure Product Details
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Allow User To Change Domain Name
 +
|}
 +
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 10px 0px 0px 30px;"|✔ Order Service For Mail Server Domain
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ View/Edit Service Configuration:
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Domain Name
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Transport Host/Port/Protocol
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 45px;"|✔ MX Usage Status
 +
|}
 +
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 10px 0px 0px 30px;"|✔ Deliver Proxmox Mail Gateway Security Solution To Protect Clients Mail Servers Against Threats
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports Proxmox Mail Gateway 7.X And Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.2 Up To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.0 And Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.1 And Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/payment-gateway-allocator#open-source-version Open Source Version]
+
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/proxmox-mail-gateway#open-source-version Open Source Version]
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/payment-gateway-allocator Payment Gateway Allocator For WHMCS.]''' <br />
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/proxmox-mail-gateway Proxmox Mail Gateway For WHMCS.]''' <br />
 
We will guide you step by step through the whole installation and configuration process.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
Line 95: Line 113:
 
|}
 
|}
  
−
==Configuration of Addon==
+
==Server Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now, we will show you how to configure a new server.'''<br />
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Payment Gateway Allocator' '' and press '' 'Activate' '' button.
+
To do so, log into your WHMCS and go to '' 'System Settings' '' → '' 'Servers'.''<br />
 +
Once you are there, press '' 'Add New Server'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''7. Next, enter your server name, hostname and IP address, username and password. Choose '' 'ProxmoxMailGateway' '' from a dropdown menu.'''''<br/>
−
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near desired admin role groups and press '' 'Save Changes'. ''
+
If you want to provide data for a Linux user account in '' 'Authentication' '' select '' 'Linux PAM standard authentication' '', and for ProxmoxMailGateway user select '' 'Proxmox Mail Gateway authentication server'. '' <br/> Remember to save the changes when ready.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_7.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''8. After you configure your server correctly, you will see the following screen.'''<br />
 +
At this point, you need to create a new group for your server. For that purpose, press '' 'Create New Group'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_8.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''9. Enter the name, click on your previously created server, press '' 'Add' '' and then '' 'Save Changes'. '''''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_9.png]]
 
|}
 
|}
  
−
==Additional Steps Required==
+
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''8. Now, proceed to '' 'Setup' '' → '' 'Payments' '' → '' 'Payment Gateways'. '' '''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''10. In order to create and configure a product, go to '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Products/Services'.'''''<br />
−
Find '' 'Redirect Per Country / State' '' and '' 'Credit Card Per Country / State' ''gateways and activate them.<br />
+
Click on '' 'Create a New Group'.''
−
<!--'''Note: If you wish to forbid card payment or redirect payment, simply do not activate related gateway.''-->
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. Afterwards, move to '' 'Manage Existing Gateways' '' to rename them. Press '' 'Save Changes'. '''''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''11. Enter your product group name and press '' 'Save Changes'.'''''
−
These gateways will be used in place of any other gateway and forward all data to a gateway depending on configuration of Payment Gateway Allocator.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''10. You have just successfully installed Payment Gateway Allocator For WHMCS!'''
+
|style="padding: 0px 0px 15px 15px;"|'''12. Once you have a product group, you can create a new product.'''<br />
 +
To do so, first click on '' 'Create a New Product'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''13. Afterward, choose your product type, enter your product name, choose module and the product group from the dropdown menus. Press '' 'Continue'. '' '''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''14. At this moment, in the product '' 'Details','' you may also check the '' 'Require Domain' '' option as providing a domain must be a required step in the service ordering process.'''<br/> Alternatively, you may add an adequate custom field to let the clients enter the domain name there ''(see step 17'').
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_14.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''15. Now, go to the '' 'Module Settings' '' section, choose your previously created server group from the dropdown menu.'''<br />
 +
If you did not set the proper permissions, you will be asked to do it now.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''16. Let's start configuring the product settings finally. Choose whether you wish to allow your clients to change the domain name or not.'''<br/> Toggle the '' 'Change Domain Name' '' option and save the changes.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_16.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''17. In case you did not mark the '' 'Require Domain' '' option in the product '' 'Details' (step '14th'),'' move to the '' 'Custom Fields' '' tab and create a 'domain|Domain' custom field.''' <br/> Do not forget to mark it as a '' 'Required Field' '' and  '' 'Show On Order Form'.'' Only then your clients will be able to successfully order and use this security tool for their relay domains.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_17.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|That is all. Your product is now ready to use so move to the following sections to learn about all the possibilities it may give you and your clients.
 
|}
 
|}
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you the possibilities
+
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show and discuss every benefit that using  the Proxmox Mail Gateway solution may bring. <br/>
 +
Go through the below descriptions to become familiarized with all the options of this security tool may offer you.
 
|}
 
|}
−
==Settings==
+
==Admin Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|At th
+
|style="padding: 10px 0px 15px 15px;"|'''Proxmox Mail Gateway For WHMCS allows you to monitor and edit your service configuration details from the admin area of your WHMCS system.'''<br />
 +
This includes supervision of such features like:
 +
* Domain Name
 +
* Transport Host
 +
* Transport Port
 +
* Transport Protocol
 +
* MX Usage Status <br/>
 +
 
 +
Basic module commands that can be executed on the service:
 +
* Create
 +
* Suspend
 +
* Unsuspend
 +
* Terminate
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_18.png]]
 +
|}
 +
 
 +
==Ordering==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|That is how an exemplary page with the order may look like. Please be aware that a domain is obligatory when placing the order.<br.> The relay domain may also be provided in the form of a custom field to be filled in depending on the product configuration, just like on the screen below. 
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_20.png]]
 +
|}
 +
 
 +
==Client Area==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Proxmox Mail Gateway For WHMCS assures protection to your clients' mail servers against threats. Your clients are allowed to view and edit the service details, including:
 +
* Domain name
 +
* Transport of Host, Port and Protocol
 +
* MX Usage Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 25px;"|[[File:PMG_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In
+
|style="padding: 0px 0px 20px 15px;"|Edit the service details, press the edit icon marked on the below screen. A new widow will appear.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 25px;"|[[File:PMG_9_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PMG_22.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|
+
|style="padding: 0px 0px 15px 15px;"|You may now change your service for mail server details. Select options, change the configuration.<br/> Remember to confirm your changes in the end.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_9_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PMG_23.png]]
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|1.
+
|style="padding: 10px 0px 30px 15px;"|
 
|}
 
|}
  

Revision as of 14:29, 9 February 2022

Contents

About Proxmox Mail Gateway For WHMCS

Proxmox Mail Gateway For WHMCS is a modern security tool that assures protection to mail servers from any kind of threats.

The module allows to perform the core management actions on the Proxmox Mail Gateway services directly from your WHMCS, from both the admin and the client side.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Service
✔ View/Edit Service Configuration:
✔ Domain Name
✔ Transport Host/Port/Protocol
✔ MX Usage Status
✔ Configure Product Details
✔ Allow User To Change Domain Name
  • Client Area Features:
✔ Order Service For Mail Server Domain
✔ View/Edit Service Configuration:
✔ Domain Name
✔ Transport Host/Port/Protocol
✔ MX Usage Status
  • General Info:
✔ Deliver Proxmox Mail Gateway Security Solution To Protect Clients Mail Servers Against Threats
✔ Multi-Language Support
✔ Supports Proxmox Mail Gateway 7.X And Later
✔ Supports PHP 7.2 Up To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.1 And Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

This tutorial will show you how to successfully install and configure Proxmox Mail Gateway 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

Server Configuration

6. 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'.

PMG 6.png
7. Next, enter your server name, hostname and IP address, username and password. Choose 'ProxmoxMailGateway' from a dropdown menu.

If you want to provide data for a Linux user account in 'Authentication' select 'Linux PAM standard authentication' , and for ProxmoxMailGateway user select 'Proxmox Mail Gateway authentication server'.
Remember to save the changes when ready.

PMG 7.png
8. 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'.

PMG 8.png
9. Enter the name, click on your previously created server, press 'Add' and then 'Save Changes'.
PMG 9.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'.

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

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

PMG 12.png
13. Afterward, choose your product type, enter your product name, choose module and the product group from the dropdown menus. Press 'Continue'.
PMG 13.png
14. At this moment, in the product 'Details', you may also check the 'Require Domain' option as providing a domain must be a required step in the service ordering process.
Alternatively, you may add an adequate custom field to let the clients enter the domain name there (see step 17).
PMG 14.png
15. 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.

PMG 15.png
16. Let's start configuring the product settings finally. Choose whether you wish to allow your clients to change the domain name or not.
Toggle the 'Change Domain Name' option and save the changes.
PMG 16.png
17. In case you did not mark the 'Require Domain' option in the product 'Details' (step '14th'), move to the 'Custom Fields' tab and create a 'domain|Domain' custom field.
Do not forget to mark it as a 'Required Field' and 'Show On Order Form'. Only then your clients will be able to successfully order and use this security tool for their relay domains.
PMG 17.png
That is all. Your product is now ready to use so move to the following sections to learn about all the possibilities it may give you and your clients.

Management

In this section we will show and discuss every benefit that using the Proxmox Mail Gateway solution may bring.

Go through the below descriptions to become familiarized with all the options of this security tool may offer you.

Admin Area

Proxmox Mail Gateway For WHMCS allows you to monitor and edit your service configuration details from the admin area of your WHMCS system.

This includes supervision of such features like:

  • Domain Name
  • Transport Host
  • Transport Port
  • Transport Protocol
  • MX Usage Status

Basic module commands that can be executed on the service:

  • Create
  • Suspend
  • Unsuspend
  • Terminate
PMG 18.png

Ordering

That is how an exemplary page with the order may look like. Please be aware that a domain is obligatory when placing the order.
The relay domain may also be provided in the form of a custom field to be filled in depending on the product configuration, just like on the screen below.
PMG 20.png

Client Area

Proxmox Mail Gateway For WHMCS assures protection to your clients' mail servers against threats. Your clients are allowed to view and edit the service details, including:
  • Domain name
  • Transport of Host, Port and Protocol
  • MX Usage Status
PMG 21.png
Edit the service details, press the edit icon marked on the below screen. A new widow will appear.
PMG 22.png
You may now change your service for mail server details. Select options, change the configuration.
Remember to confirm your changes in the end.
PMG 23.png

Tips

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.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Proxmox_Mail_Gateway_For_WHMCS&oldid=58390"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Proxmox Mail Gateway For WHMCS