MSPControl Extended For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About MSPControl Extended For WHMCS

MSPControl Extended For WHMCS allows to automate accounts provisioning and lets your clients manage their MSPControl accounts through your system.

The module enables your customers to order and manage their web hosting accounts straight in your WHMCS client area.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Account
✔ Change Package And Password Of Account
✔ Log In To Each MSPControl Account On Click
✔ Log In To Each MSPControl Admin Panel On Click
✔ Configure Client Area Features Per Product
✔ Define Hosting Plan To Limit Resource Per Product
✔ View All MSPControl And MSPControl Extended Products And Servers In One Place
✔ Run API Connection Test
  • Client Area Features:
✔ Remote Access And Management Of:
✔ DNS Management - Requires DNS Manager For WHMCS
✔ Web Sites
✔ Email Accounts
✔ Email Aliases
✔ Email Domains
✔ Email Groups
✔ Email Lists
✔ FTP Accounts
✔ Files Manager
✔ One Click Login To MSPControl
✔ Change Account Password
  • General Info:
✔ Integrated With DNS Manager For WHMCS - Manage DNS & rDNS Records (read more)
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Specified Servers To Products (read more)
✔ Multi-Language Support
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation and Configuration

Read the below instructions to learn how to install and then configure MSPControl Extended For WHMCS properly.

We will guide you step by step through the installation procedures.

Installation

1. Log in to your client area and download the module.
MSP1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

MSP2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

Rtyrty.png
4. When you install MSPControl Extended For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/servers/MSPControlExtended/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

MSP3.png
5. In order to configure your license key you have to edit a previously renamed 'license.php' file.

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

MSP4.png

Activation of Addon

6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Click 'Setup' and find 'Addon Modules'.
Afterwards, find 'MSPControl Extended Center' and press 'Activate' button.

MSP5.png
7. In the next step, you need to permit access to this module.

To do so, click on 'Configure' button, tick desired admin roles and press 'Save Changes'.

MSP6.png
8. MSPControl Extended For WHMCS is now successfully installed!

Access the addon under 'Addons' 'MSPControl Extended Center'.

Configuration of Server

9. To begin, you must add a new server.

Go to 'Setup' 'Products/Services' 'Servers' and press 'Add New Server'.

MSP8.png
10. Enter your server name, IP address, username and a password. Choose 'MSPControlExtended' from a dropdown menu and press 'Save Changes'.

If you connect with your MSPControl server via SSL, then make sure that you checked 'Secure' located at the bottom of the page.

MSP9.png
11. Once your server has been configured correctly, you will see a following screen.

Create a new group for your server. Press 'Create New Group' to follow.

MSP10.png
12. Enter name, click on your previously created server, press 'Add' then 'Save Changes'.
MSP11.png

Configuration of Product

13. In order to create a product, go to 'Setup' → 'Products/Services' → 'Products/Services'.

If you do not have a product group, click on 'Create a New Group'. If you do, simply skip step 13.

MSP12.png
14. Fill in a product group name and press 'Create Group'.
MSP13.png
15. When you have a product group added, you can create your product and assign it to MSPControl Extended module.
MSP14.png
16. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
MSP15.png
17. Now, go to 'Module Settings' section, choose both 'MSPControlExtended' and a previously created server group from dropdown menus and press 'Save Changes'.

Important: Setting MSPControl theme is required for some features to work properly.

MSP16.png
18. Fill in 'Parent Space ID', 'Plan ID', 'Enterprise Server Port' and 'Portal URL' fields.

Additionally, check 'Create Mail Account', 'Create Temporary Domain', 'Create Website', 'Create FTP Account', 'Count Bandwidth / Diskspace' and 'Create DNS Zone'.
Confirm through pressing 'Save Changes'.

MSP16 1.png

Configuration of Addon

19. You have just correctly created and customized a new product.

Go to 'Addons' 'MSPControl Extended Center' in your WHMCS. You will find there dashboard with precise data on products and servers:

  • see the number of active/suspended/terminated MSPControl and MSPControl Extended products
  • check the number of active accounts
  • log into Admin Panel
  • press 'Documentation' tab to be moved to this very site!
MSP17.png
20. Proceed to 'Features' section and find the product you are interested in and press 'Configuration' button next to it.
MSP17 1.png
21. You should find there boxes dedicated to 'Copy Configuration' and 'Features'.

If you have already another product configured, you may copy its configuration now.

MSP18.png
22. To show you an example, we will set the configuration from the beginning, we will not use other product's configuration.

Select the features you would like to activate for your customers and save the changes.

MSP19.png
23. From now on, all your clients who ordered a previously created product will be able to manage their MSPControl accounts via your WHMCS system.

Here a view of the ordered product summary in admin area. Available actions:

  • Log In To Control Panel
  • Use Module Commands: 'Create', 'Suspend', 'Unsuspend', 'Terminate' the product; 'Change Package' and 'Change Password'
MSP20.png
This is what your customers should see in their client area:
MSP21.png

Management

MSPControl Extended allows your customers to manage their MSPControl accounts without being logged into the server.

Read the below descriptions to become familiarized with all of the MSPControl Extended functionalities.

Client Area

In the following section, features available in the client area will be thoroughly discussed.

Web Sites

Under the first subsection you can add your websites. Type in the web site address and select one from your domains.
Press 'Create'.
MSP41.png
You may always delete (2.) or edit (1.) an existing website. Use action buttons marked on the screen to do so.
MSP42.png
When you press the pencil icon, you are moved to place where details on your website can be updated.

Available options:

  • Home - directory and its details
  • Website Pointers
  • Extension
  • Custom Errors
  • Headers
  • MIME Types
MSP43.png

Email Accounts

Create and edit email accounts that are associated with your domains. Modify or remove mailboxes.

To add a new mailbox, press 'Create'.

MSP23.png

Email Aliases

Set up email aliases, fill in the address of one of your mailboxes and choose its domain.

Then, fill in the full list of email addresses to forward to and press 'Add Forwarder'. You may remove the forwarder whenever you need.

MSP24.png

Email Domains

Addon domains allow you to link the domain to a subdirectory of your account.
Manage addon domains, create subdomains, use password generator to enjoy full security. Redirect and assign users to crated addon domains.
MSP25.png

Email Groups

Now, provide an email address which will be used as an email resender.

Additionally, fill in the list of email addresses which should receive email and press 'Create'.

MSP26.png

Email Lists

Prepare email lists. Add several email addresses to one list to avoid sending one message to numerous users one by one.

Predefined lists make the sending notification system much more advanced and faster.

MSP27.png

FTP Accounts

Add and configure FTP Accounts in the easiest way possible. Just type in login, generate a totally secure password, provide directory and define access rights.
Use action buttons to:

1. Change access rights
2. Change password
3. Delete account

MSP28.png

File Manager

Manage files and folders of your MSPControl account. Upload files, create folder to categorize the files, compress, extract etc.

View the list of files with specific data on them: name, file size, last modification date and given permissions.

MSP29.png
Actions allowed on each file or all selected files:
  • compress one file or more
  • extract compressed files
  • copy files (if in target folder there are files with the same name they will be replaced with the new ones)
  • move files (if in target folder there are files with the same name they will be replaced with the new ones)
  • delete files
  • rename files
  • change permissions (read/write)
MSP29 1.png

DNS Management (requires DNS Manager For WHMCS)

If integrated with DNS Manager For WHMCS, one more button is available on the products management page. Use it and you will be redirected to zones management page.

Please visit our DNS Manager For WHMCS wiki site to learn more about zones creation and management.

MSP30.png
Thanks to DNS manager For WHMCS features, DNS zones are automatically created. Clients may manage zones directly from their MSPControl product.
MSP31.png

One Click Login To MSPControl

Get quick access to your MSPControl with just one click. You don't even need to fill in your username and password!
MSP32.png

Tips

1. If you want to maintain a higher control over your clients management of the account, turn off the option to log into the external server in the addon.
2. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
MSPControl Extended For WHMCS