Personal tools
Namespaces

Variants
Actions

Proxmox Mail Gateway For WHMCS

From ModulesGarden Wiki
Revision as of 13:33, 7 February 2022 by Karolina (Talk | contribs)

Jump to: navigation, search

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

Before you can go on, you need to generate the user ID and the API key pair, they will be necessary to successfully connect to the VHI server.

Please follow the below steps to generate the access data:

  1. Log in via SSH to your VHI server
  2. Run the below command:
ostor-s3-admin create-user

Follow instructions that are visible in your console.

Please refer to the official Virtuozzo documentation Creating S3 User to get detailed instruction.
Once you have the access keys generated, copy them and keep safe as you will need them in the next step of the server configuration.

6. Now, log in to your WHMCS and proceed to 'System Settings' 'Products/Services' 'Servers' and press 'Add New Server'.
VHI 7.png
7. Next, enter your server 'Name' , 'Hostname' and select 'Virtuozzo Hybrid Infrastructure S3' from the 'Module' field.

Now, provide your 'VirtuozzoHybridInfrastructureS3' API details that you generated in the previous step:

  • Username 'S3AccessKeyId'
  • Password 'S3SecretAccessKey'.

Make sure that your server connection is correct and save the changes.

VHI 8.png
8. It is time to create a server group. To do so, click on 'Create New Group'.
VHI 9.png
9. Enter a name, click on your previously created server, press 'Add' and afterward 'Save Changes'.
VHI 10.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 first section is dedicated to basic product configuration, select email type that will be used to create the service, provide all the required data:
  • 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.
    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
VHI 16 1.png
Next move to setting the user limits, define the operations limit and bandwidth.

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

Bandwidth

  • Out [Mb/s] - define an outgoing bandwidth limit
VHI 17.png
The next section is dedicated to quota management:
  • User Quota [GB] - define the storage usage limit per user in gigabytes
VHI 18.png
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
VHI 19.png
Now, select which options you want to generate and confirm by clicking 'Create' .
Note that the configuration for disabled options will still be taken from the configuration of the main product.
More information about how to use configurable options can be found here or in the official WHMCS documentation.
VHI 20.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