DirectAdmin Extended For WHMCS

About DirectAdmin Extended For WHMCS

DirectAdmin Extended For WHMCS will bring the automation into the provisioning and management of web hosting accounts in your WHMCS. The module will allow your clients to remotely handle FTP accounts, create backups, install SSL certificates as well as set up various applications with the inbuilt installers.

• Admin Area Features:

✔ Create/Suspend/Unsuspend/Terminate Account

✔ Change Package And Account Password

✔ Log In To Each DirectAdmin Account On Click

✔ Log In As Admin To DirectAdmin Panel On Click

✔ Automatically Suspend Client Account Upon Reaching Bandwidth Limit

✔ Configure Client Area Features Per Product

✔ Configure Resource Limits Per Product

✔ Define FTP Backups Endpoints Per Product

✔ Define Backup Directory Paths Per Product

✔ Enable And Configure Application Auto Installer To Use Per Product - Softaculous Or Installatron

✔ View All DirectAdmin Extended Products And Servers In One Place

• Client Area Features:

✔ Remote Access And Management Of:

✔ Addon Domains, Their Details, PHP Version And Logs

✔ Apache Handlers

✔ Applications And Their Backups

✔ Autoresponders

✔ Backups, Remote FTP Backups And Admin Backups

✔ Catch All Email

✔ Cron Jobs

✔ Custom Error Pages

✔ Databases And Their Backups

✔ DNS Records

✔ Domain Pointers And Their DNS Records

✔ Email Accounts

✔ Email Forwarders

✔ File Manager

✔ FTP Accounts

✔ Hotlinks Protection

✔ Mailing Lists

✔ Perl Modules

✔ Protected Directories

✔ SPAM Filters

✔ SSH Keys

✔ SSL Certificates

✔ Site Redirections

✔ Site Summary

✔ SpamAssassin Setup

✔ Subdomains

✔ Unban IP Address

✔ Vacation Messages

✔ WordPress Manager - Separate Module Required

✔ One Click Login To:

✔ DirectAdmin

✔ phpMyAdmin

✔ SitePad

✔ Webmail

✔ View Account Resource Usage

✔ Change Account Password

• Application Auto Installer Features:

✔ Ordering Process:

✔ Auto Install Chosen Application After Account Creation

✔ Auto Install Application Chosen By Client During Order - With Configurable Options

✔ Allow Custom Settings Of Auto Installed Application - With Custom Fields

✔ Client Area:

✔ Install New Applications With Softaculous And Installatron

✔ View And Manage Installed Applications

✔ Backup Installed Applications

✔ View And Manage Created Backups

✔ Restore Applications From Backups

✔ Delete Applications Along With Their Backups

• Configurable Options:

✔ Addon Domains

✔ Anonymous FTP Accounts

✔ Autoresponders

✔ Bandwidth

✔ CGI Access

✔ Catch All Email

✔ Cron Jobs

✔ DNS Control

✔ Dedicated IPv4 Address

✔ Dedicated IPv6 Address

✔ Disk Space

✔ Email Accounts

✔ Email Forwarders

✔ FTP Accounts

✔ Inode Limit

✔ Mailing Lists

✔ MySQL Databases

✔ PHP Access

✔ Parked Domains

✔ Server IPv4 Address

✔ SSH Access

✔ SSL Access

✔ SpamAssassin

✔ Subdomains

✔ Suspend At Limit

✔ System Information

• General Info:

✔ Integrated With Advanced Billing For WHMCS - Actual Server Resource Usage Billing (read more)

✔ Integrated With IP Manager For WHMCS - Complete Control And Easy Assignment Of IP Subnets (read more)

✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products (read more)

✔ Integrated With WordPress Manager For WHMCS - Remote Installation And Management Of WordPress Instances (read more)

✔ Fully Integrated With Lagom Client Theme

✔ Multi-Language Support

✔ Supports WHMCS Server Sync Tool

✔ Supports WHMCS Metric Billing - Integration: Disk Space, Bandwidth, Email Accounts, Addon Domains, Parked Domains, Subdomains, MySQL Databases, MySQL Disk Usage, Sub-Accounts

✔ Supports PHP 7.2 Up To PHP 7.4

✔ Supports WHMCS Themes "Six" And "Twenty-One"

✔ Supports WHMCS V8.2 And Later

✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

This tutorial will focus on how to successfully install and manage DirectAdmin Extended For WHMCS. We will guide you step by step through the whole installation process.

Installation

1. Log in to our client area and download the module.

2. In the downloaded file you might find one or two packages that support different PHP versions. In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

Previous updates of the module may contain two packages dedicated to various PHP versions. The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4. Note: Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

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

3. Extract the package and upload its content into the main WHMCS directory. The content of the package to upload should look like this.

4. When you install DirectAdmin Extended For WHMCS for the first time you have to rename the 'license_RENAME.php' file. The file is located in 'modules/servers/directadminExtended/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

5. In order to configure your license key you have to edit the 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 our client area → 'My Products'.

6. In the next step, set up the two 'storage' folders as recursively writable. Both folders are available at 'yourWHMCS/modules/addons/DirectAdminExtended/storage' and 'yourWHMCS/modules/servers/directadminExtended/storage' .

Addon Activation

7. Now, you have to activate the module in your WHMCS system. Log in to your WHMCS admin area. Move to 'System Settings' then choose 'Addon Modules'. Afterwards, find 'DirectAdmin Extended' and press the 'Activate' button.

8. In the next step you need to permit access to this module. To do so, click on the 'Configure' button, select required administrator groups and press 'Save Changes'.

9. Well done! You have just successfully installed DirectAdmin Extended For WHMCS! You may access your addon under 'Addons' → 'DirectAdmin Extended'.

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

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

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

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

Product Configuration

14. In order to create and configure the product, click on 'System Settings' → 'Products/Services'. If you do not have a product group, click on 'Create a New Group'. If you do, simply move to the step 15.

15. Enter the product group name and press 'Save Changes'.

16. When you have a product group, you can create your product and assign it to DirectAdmin Extended. If you already have a product, jump to the step 17. To create a product, click on 'Create a New Product'.

17. Afterwards, choose your product type and product group from dropdown menus, then enter your product name and select the used module: 'DirectAdmin Extended'. Press 'Continue'.

18. Then, you need to move to the 'Module Settings' section and choose your previously created server group from dropdown menu. Choose a preconfigured 'Package' you want to use Select 'Reseller IP Address' if required: 'Shared' - the domain will use the server's main IP 'Shared - Reseller's IP' - the domain will set the resellers IP to shared and assign the reseller to it 'Assigned' - the domain will use one of the reseller's IPs 'Share Server IP Address with Reseller' - allow resellers to create sites with the server IP address (resellers only) 'IP Addresses Assigned to Reseller' - define the number of IP addresses assigned to a reseller for product configuration (resellers only) You can also activate the feature to automatically suspend accounts when the bandwidth limit is reached. Simply tick 'Suspend at Limit'. Don't forget to press 'Save Changes' in the end.

19. If you would like to set up your own configuration, choose 'Custom' from the 'Package' dropdown. A list of customizable options will appear. Configure them at your own discretion or generate Configurable Options instead. Also, you can generate custom fields if you wish to use the product with Auto Installed Applications.

Addon Configuration

20. Go to 'Addons' → 'DirectAdmin Extended'. The dashboard located there contains the precise data on available products and servers: see the number of active/suspended/terminated products check the number of active accounts log into panel upgrade your DirectAdmin products press the 'Documentation' tab to be moved to this very site!

21. Proceed to the 'Features' section, find the product you are interested in and press the 'Configuration' button next to it.

22. You should see boxes dedicated to 'Features', 'Applications' and 'Other' Begin by selecting the features you would like to activate for your customers.

23. Choose whether to activate the 'Install Applications' option. In case you wish to enable this feature, you will have to select 'Auto Installer' from a dropdown menu. After, activate 'Install Button' and 'Backup Button'. You can also choose a desired language of the applications by typing in its two-letter code into the 'Language' field. A complete list of language codes can be found here. If the field is left blank, a default value, which is 'en' (English) will be used. Note: You can also create a configurable option with app to be installed, you can find the relevant instruction here.

24. Finally, select the 'Webmail' button redirection from the 'Other' and choose 'Show Server IP' address. Do not forget to 'Save' changes once the product configuration is ready!

If the 'Show Server IP' address option is on, it will be visible in the client area for customers.

If the 'Let's Encrypt' button is toggled on, your customers will see it under the 'SSL Certificates' menu.

25. (Optional) Move to the 'Backups' tab where you can define the FTP backup path under 'FTP Backups Endpoints' and 'Backup Directory Path'. This will allow creating backups on external servers defined by their admin, which then will be available for the clients to choose. Find more about Backups here.

Define the FTP backup path under 'FTP Backups End Points'. Simply fill out the form with 'Backup Name', 'Host', 'Port', 'User', 'Password' and 'Path to Files'. Afterwards, save it by pressing the 'Save' button.

Under the Backup Directory Path, enter the backup path which can be found in your DirectAdmin server → 'Admin Backup/Transfer' → 'Local' textbox.

26. If you already have another product configured, you may copy its configuration. Find the 'Copy Configuration' button on the list with products or select multiple items at once. Then choose the product configuration which settings you wish to copy into the selected products.

27. That's all, you have just correctly created and customized a new product, now you can check the results. This is what your customers should see in your client area.

28. From now on, all your clients who will order the previously created product, will be able to manage their DirectAdmin accounts via your WHMCS system. Below you can see the view of the ordered product summary in the admin area. Available actions: Log In To Control Panel Use the module commands: 'Create', 'Suspend', 'Unsuspend', 'Terminate' the product; 'Change Package' and 'Change Password'

Management

DirectAdmin Extended allows your customers to manage their DirectAdmin accounts directly in your WHMCS client area. This short guide will present you the possibilities of our addon module.

Your Account

In the below sections, you will find basic tools used to manage your DirectAdmin account shown and described. Analyze them carefully to enjoy full and easy management.

Addon Domains

Addon domains allow you add and manage your addon domains. Take a look at the domain details, view error and usage logs, change the PHP version if applicable and suspend or unsuspend domains.

Press the 'Create Addon Domain' button and enter a new domain name, specify bandwidth and disc space, select options you may need: 'Secure SSL' 'Force SSL With HTTPS Redirect' 'CGI Access' 'PHP Access' 'Local Mail Server'

Press the 'Information' icon to see the domain details.

You may also check the list of 'Error' and 'Usage Logs' of each addon domain.

Select a 'PHP Version' and enable/disable the 'Local Mail Server' of the addon domain. Keep in mind that this option is available only if it is enabled and managed on the product's DirectAdmin server. Otherwise, the 'There is no PHP Selector Enabled' information will be displayed and the option disabled.

Applications

Manage your applications straight from your WHMCS client area. Install new applications, create backups if needed and delete unused apps. A separate section has been dedicated to applications, please move to section Install Applications to learn how to manage applications and their backups.

Backups

This tab, 'User Backups', allows you to back up your DirectAdmin user account. To delete backup, simply press an adequate icon.

You can select what exactly you want to backup. Mark checkboxes next to the setting you would like to make the backup of. Afterwards, press the 'Create' button to order it.

You may restore your backups at any time, you can do it by pressing the 'Restore' button next to the backup. Then, toggle options that you want to restore with this action. Note: Only backed up features are available here to choose, all the others are hidden.

At 'Admin Backups' and 'FTP Backups' sections you will get a list of backups created by your administrator and FTP Backups, you may view a list of backups of a given server. Note: Please refer to Tips section, point 4, to learn how to manage FTP and Admin backups.

Databases

Owing to the MySQL databases management, you can create and delete databases.

Type in the required information and generate a secure password.

You can also add users to particular databases, use action buttons to delete needless users or change their password.

Remember that you should always use the secure password generator while creating a user.

Once the user has been created, you can edit it to set appropriate privileges then. Toggle privileges you wish to assign to the user and confirm the changes.

It is also possible to change the user's password in case of any need.

DNS Management

This section gives you the possibility to manage the 'DNS Records' of your domain easily. You can create new records as well as edit the existing ones.

As presented below, there is a list of your existing 'DNS Records' . You can edit them or delete if they are no longer needed. If you wish to add a new 'DNS Record' , simply click on the appropriate button.

Now, choose the type of your 'DNS Record' and provide its name and value.

Press the button to restore the DNS configuration to default.

You must be aware that after restoring the default configuration, all the custom entries you have made will be erased. </br>If you are sure, just press 'Confrirm' button to restore default DNS configuration.

File Manager

Manage files and folders of your DirectAdmin account. Upload files and create directories. View the list of files with specific data on them: name, file size, last modification date and given permissions.

You can create a new directory by pressing a corresponding button as well as upload new files by pressing additional actions.

Rename, change permissions, copy, protect and delete a single file or directory. Note: Only folders placed in the public_html directory can be protected, no other files have this option. All files with this opton enalbed will be listed in the Protected Directoiries section.

You can also change permissions and remove single or multiple files or directories.

FTP Accounts

Manage FTP accounts in the easiest possible way. Type in your login, generate a new password and select the directory. Handle the accounts to be able to access your website files through an FTP protocol. You can also suspend or unsuspend created accounts.

Add and configure FTP Accounts, just type in your login on a selected domain, provide or generate a secure password, select directory: 'Domain', 'FTP', 'User' ' or a custom one.

Hotlinks Protection

'Hotlinks Protection' section is a place where you may enable and disable protection of single links to the content of your website. This way you mayt avoid your content, for example images, from being stolen or badwidth abused. Press the icon next to every of your domains to see existings, currently protected URLs.

In this section you may add new URLs to protected or remove existing ones from the list of hotlinks. Press 'Add new URL' to protect another link.

Type in your URL, you may use '*' sign to hide part of the URL and confirm the action.

Define protection settings for all the URLs

Enable/disable protection Type in the proteceted file types, use to comma to separate, do not use spaces in between Allow blank referrer Allow redirection Provide redirection URL if enabled

Perl Modules

Move to the next section, which is 'Perl Modules'. All Perl based modules installed on your server are listed there.

Subdomains

Create subdomains for your website sections. All you need to do is choosing the domain from the list of available domains and typing in the subdomain name. Once created, you can remove the subdomain if needed, see its bandwidth usage and view a list of subdomain logs.

Choose the domain for your available subdomain from the list.

Site Summary

Proceed to the 'Site Summary' section in order to check and analyze precise statistics. Control usage level for each setting here.

Email Management

Email management section includes all tools related to emails. Go through them to learn more.

Autoresponders

In this section you may compose and add extremely useful default messages. They will be automatically sent as a response message when you have no access to your mailbox.

Press 'Add Autoresponder' to create one. Provide the email address and compose the whole message here. You may also add a CC recipient address if you need to send a copy.

Catch All Email

'Catch All Email' is a feature that allows you to forward emails that are sent to the non-existent email address of your domain name. Click on the 'Edit' button as shown here:

Now, here are three options available. Choose the preferred option and save changes. Fail - the sender will be informed that the recipient does not exist Ignore - the email is dropped, no message is sent back Address - the email will be forwarded to an email address of your choice.

Email Accounts

View and edit email accounts that are associated with your domains. Use a filter to find required email addresses, preview its selected quota, number of sent messages and manage the account. View SMTP Logs - incoming and outgoing Change Password Edit Limits Download Outlook Configuration Delete Account

Press 'Create Account' and select to which domain it shall be added, type or generate password, define limited or unlimited quota and limit of messages.

Email Forwarders

In this section you can set up email forwarders and choose from several destination options to adjust mail forwarding perfectly to your needs.

Press the 'Create Forwarder' button, specify the forwarded email and define the destination emails. You may add more than one forwarder name and destination emails, use a comma to separate them.

Mailing Lists

Mailing lists allow you to use a single address to send message to multiple email addresses. This feature is very useful when you need to send a newsletter or another update to a group of people. Underneath, you can find a list of your mailing lists. Use action buttons to delete a list, view its details and alter settings.

Create a new mailing list by providing its name.

Modify the mailing list in the 'Settings' section.

When you 'Edit' the list, you will be moved to the section where a list of subscribers is available.

Add new email addresses to the list of 'Subscribers' or 'Digest Subscribers' from the according tab.

SPAM Filter

SPAM Filters give you the possibility to add numerous filters for a selected domain.

Add and configure the filter as desired for the selected mailbox. block email addresses block email domains block emails with a chosen word block emails larger than the specified number of kilobytes

Move to settings and define options per domain: define the action for blocked emails: 'Drop Email' or 'Send To SPAMbox' adult filter - enable/disable

SpamAssassin Setup

On this page, you can configure your SpamAssassin. You can set up: Action performed on spam emails Threshold Define separate actions for spam emails of the above defined threshold Define whether to change the spam email subject or leave it intact Choose how spam should be delivered Specify blacklisted email addresses Specify whitelisted email addresses

Vacation Messages

The goal of 'Vacation Messages' is similar to the one of Autoresponder shown above. The only difference is that the vacation message replies only to the first email received per email address. Note: If there is already an autoresponder set up for the account, it will be impossible to set a vacation message to that account.

Type in the message content, define your vacation start and end time.

Advanced Features

Advanced tools are used to configure sophisticated settings of your account.

Apache Handlers

Under the 'Apache Handlers' page, you can define custom handlers for chosen file extensions or specific files. You can read more about Apache Handlers here.

To add a new handler, type its name and then extensions it will process.

Cron Jobs

Cron Jobs section allows you to easily add and remove your cron tasks.

Select cron job settings to fully automate commands and scripts on your site.

Custom Error Pages

Defining custom apache error pages is easy with 'Error Pages'.

You can alter or define a new HTML code of error pages displayed during 401, 403, 404 and 500 errors.

Domain Pointers

In the 'Domain Pointers' section you can manage your aliases and pointers. You can have access to the content of one domain from another one!

Enter a source domain, then select type: 'Alias' or 'Pointer'.

Manage DNS records of the domain pointer.

Edit, delete and create DNS records of a single domain pointer.

Select record type, enter name and value. In case of 'MX' record type define priority and a hostname. Note that the lower preference number stands for the higher priority.

Protected Directories

Protected directories section includes a list of domains with any folders protected with a password. Press the icon to see an exact list of protected folders. Important: You may protect single folders directly in 'File Manager' section, however, they must be located in the 'public_htlm' directory only.

Details section contains a direct path to the protected folder, you may also perform flowing actions on single directories: View/Add directory users Edit directory name Delete single directory protection Use mass action button to remove the password protection of the selected directories.

1. View existing users and add new ones by pressing button. Then provide the username and a password.

2. Change the folder name

Site Redirections

Easy access to site redirections is very advantageous. Within a few seconds, you can redirect the page to another.

For example, if your main domain is mytestdomain.com, you can forward it like this: mytestdomain.com/redirect → adomainwithlongname-averylongname.com Choose the type: 'Permanent', 'Temporary' or 'Replaced'.

SSH Keys

SSH Keys are responsible for providing secure file transfer and remote logins to the account. This section allows you to manage your SSH Keys easily.

Now, provide 'Key ID' and 'Comment' . Enter a strong ' Password' , optionally, you can generate it. Finally, choose the size of your SSH Key from the dropdown menu and decide if you want to authorize the Key. Afterwards, click the 'Create' button.

All newly created SSH Keys are visible here. You can 'Authorize' or 'Delete' your SSH Key using the buttons shown below:

If you wish to 'Authorize' or ' Delete' a few SSH Keys, click the appropriate mass action button.

All of authorized SSH Keys are listed in the 'Authorized Keys' section. Here you can edit one of the existing SSH Keys or delete any if no longer needed.

It is also possible to paste an existing, authorixed SSH Key. All you need to do is press the button marked on the creen and then paste your authorized key.

SSL Certificates

Your customers can benefit from generating free certificates provided by 'Let's Encrypt' . Assuming that this option was previously enabled in the Addon Configuration. Generating a CSR or a certificate with 'Let's Encrypt' will result with automatically added private keys to the list. You may also upload a ready certificate with a private key or a CA SSL Certificate (Certificate Authority). Use 'More Actions' to find appropriate buttons.

If you decide to use the easiest method of generating cerificates, that is 'Let's Encrypt' option, you will only have to fill in a short form with basic information. In 'Entries' tab you will find all existing subdomains for the selected domain.

This feature relocates completely the management of your private keys, CSR keys and SSL certificates into your WHMCS client area. Thanks to it, you can conveniently manage all the aspects of your SSL certificates without the necessity to log in to your DirectAdmin account.

If you want to obtain a certificate from a trusted provider, complete the Certificate Signing Request form to generate a CSR, which will then be used to generate the certificate by that provider.

Unban IP Address

The 'Unban IP Address' section allows clients to unban their IP address if it has been blocked in the DirectAdmin panel. Both IPv4 and IPv6 addresses can be unbanned here. Simply type in the address, press the 'Unban' button and wait until the action is complete.

WordPress Manager

If you have WordPress Manager For WHMCS module installed, your customers will fully benefit from its seamless integration with the DirectAdmin Extended For WHMCS module.

Thanks to this integration, your customers will have the capability to install and manage WordPress instances in detail without the bother of leaving the DirectAdmin Extended panel in your WHMCS client area. Full and detailed instructions on the 'WordPress Manager' itself is located here.

Please note that this entire section can only be available if you have purchased and installed the WordPress Manager For WHMCS module.

Install Applications

'Install Applications' is a very interesting and time-saving feature of DirectAdmin Extended For WHMCS module. In merely seconds, you can install your favorite applications without even accessing DirectAdmin! Firstly, you need to enable one of the two auto-installation managers. To do so, go to 'Addons' → 'DirectAdmin Extended' → 'Features'. Press the 'Configure' button next to the product you are interested in. Then, find the 'Applications ' box. Enable the 'Install Applications' checkbox, select the autoinstaller from a dropdown menu (you can choose 'Installatron' or 'Softaculous' ). You can also choose a desired language of the application by entering value into the 'Language' field. A complete list of language codes can be found here. If the field is left blank, the default value 'en' (English) will be used. Finish the process by enabling 'Install Button' and 'Backup Button'. Do not forget to save the changes.

In the client area section, move to the 'Applications' section and then find the 'Install New' tab as shown on the following screen. You will see an extensive menu of application categories.

For presentation purposes we will install 'Claroline' located in the 'Educational' section.

Necessary installation fields should be automatically filled in. In case the 'Directory' field is left empty, the application will be installed in the main folder of the selected domain.

If the installation process has been successful your newly installed application will appear on the list of installed ones when you go back to that tab.

Here you can find the name of the application, its domain, installation time and version. Available actions on installed applications: 'One Click Login' - works with 'WordPress' only, press the icon and you will be automatically moved to the admin panel created while installing 'WordPress' first instance 'Create Staging' application - create staging instances from an application, e.g. for testing purposes before pushing them to the live installation ('Softaculous' only) 'Push To Live' - push a staging application to the live environment. 'Push To Live' button (2.1) is available for 'Staging' applications only ('Softaculous' only) 'Clone' application - clone existing website installations to modify or use them on different domains ('Softaculous' only) 'Generate Backup' 'Edit' application - a form with pre-filled values will appear, you may easily modify them now. 'Delete' application Note: Please keep in mind that creating staging applications, cloning, and generating backups might last up to a few minutes and the instances are not visible right away. Please wait until they appear on the list.

Management of Auto Installed Applications

To set up DirectAdmin Extended products with the auto installed app, follow these steps: In the beginning, go to 'Product/Services', find your product connected with DirectAdmin Extended and enter the 'Module Settings' tab. Press 'Generate Custom Fields' to automatically create the required fields.

Select which of the available fields you wish to generate.

You can also create these fields manually by going to the 'Custom Fields' tab. You will need to add 8 custom fields. These are: 'Directory', 'Database Name', 'Database Username', 'Database Password', 'Table Prefix', 'Site Name', 'Site Description' and 'Language'. Remember to set the field type as 'Text Box', tick 'Required Field ' and/or 'Show on Order Form' exactly as it is shown on the screen below. Note 1: 'Site Description' is needed only for Softaculous autoinstaller. Note 2: 'Database Name', 'Database Username', 'Database Password' and 'Table Prefix' fields do not need to be filled upon ordering product by a client. If they are not filled, the database will be automatically generated. Note 3: For the Installatron auto installer use 'Site Title' in place of 'Site Name'.

Afterwards, go to 'Addons' → 'DirectAdmin Extended' → 'Features' → 'Configuration'. Enable 'Install Applications' in the Applications section. Select the auto installer and application to install from dropdown menus. Confirm by pressing the 'Save' button.

Once you add all the custom fields, they will appear while placing an order. Voila! Now your customers can personalize each application without the necessity of installing it later on.

Configurable Options For Application Auto Install

Let your clients decide which application they would like to install on their new DirectAdmin account. While placing an order, your customer can choose an application which will be installed upon account creation. There is nothing else you need to do. The application will be ready to use instantly! To set up this feature, return to the configuration of your product, find the 'Applications' section, activate 'Install Applications', choose 'Auto Installer' and activate 'Use Configurable Options'.

Go back to the list of products and click on a download icon to view the applications list.

These are the names of values that you can enter in the fields of configurable options. We will configure them in the next step. For example, if you would like to set up 'Drupal' in your applications list, you will need to enter the 'Drupal 7.59' or 'Drupal' value. 1. If you make a mistake with the application name, the auto installer will not work. 2. If you do not enter the version number, the auto installer will install the latest version of the application. Now that you know what values should be entered in configurable options for particular applications, we can proceed further.

Go to your 'WHMCS' → 'Setup' → 'Products/Services' → 'Configurable Options' and press 'Create a New Group' .

Enter the group name of your choice, select the product to which you want to assign configurable, then press 'Save Changes' .

Now click on 'Add New Configurable Option' .

This moment is very important. As 'Option Name', you have to enter 'Installation App'. Otherwise the entire functionality will not work. Here you can set up as many applications as you want. To do so, enter a value name, e.g. 'WordPress 4.9.8' and press 'Save Changes' . Repeat this as many times as you need and do not forget to set 'Option Type' to 'Dropdown' . Remember that if you do not provide the version number of the application, the latest version will be installed.

As you can see on the following screen, we decided to offer our customers five applications. When you finish adding applications, press 'Save Changes' and 'Close Window'.

You can also create a new configurable option - Auto Backup On Update with the 'Yes/No' type. This option is used to enable the creation of auto update backups for the first chosen application after the initial order in WHMCS. Please note that this option works only with Installatron plugin and Auto Update Backup Enabled By Default On Order setting in the module features has to be disabled to make this configurable option work properly.

Afterwards, come back to 'DirectAdmin Extended Features' → 'Configuration' → 'Applications' , activate 'Use Configurable Options' and choose 'Apps/Configurable Options' from a dropdown menu. Please note that you can have more configurable options groups at your disposal. Press 'Save' . You have just successfully assigned configurable options to the application autoinstall.

Let us find out what your customers are going to see in your client area while placing an order. As you can see, a dropdown menu with the previously configured applications has shown up.

Backups Management For Apps

You can also create a backup of your application. It is very easy! To do so, click 'Create Backup'.

After a few seconds, you should see the 'Success' message as a confirmation of the performed operation. To manage your backups, simply press 'Backups'.

You can quickly view, delete or restore your existing backups.

Log In To DirectAdmin

With a single click on the 'Log In To DirectAdmin' button, you can log in to your DirectAdmin without the necessity to enter login details.

Log In To phpMyAdmin

You can easily log in to your phpMyAdmin by clicking 'phpMyAdmin'. You will be redirected to that site on the run.

Log In To SitePad

To be redirected to SitePad, click on the 'SitePad' button as presented below:

Log In To Webmail

In order to enter Webmail, press 'Webmail' button as shown on the following screen. Note: Webmail type login has been defined by the admin and can be either 'Horde', 'Roundcube' or 'Squirellmail'.

Management of Resource Usage

In the product overview tab, you can find your product's current resource usage andg]]

13. Enter a name, click on your previously created server, press 'Add' and afterward 'Save Changes'.

Configuration of Product

15. In order to create and configure a product, go to 'System Settings' → 'Products/Services'. Click on 'Create a New Group'.

16. Enter your product group name and press 'Save Changes'.

17. Once you have a product group, you can create a new product. To do so, first click on 'Create a New Product'.

18. Afterward, choose your product type, enter your product name and choose the product group from the dropdown menu. Press 'Continue'.

19. Now, go to the 'Module Settings' section, choose your previously created server group from the dropdown menu. The module should automatically save and reload the settings. If not, click on the 'Save Changes' option manually.

20. Now, you can start configuring the settings of the Server you sell. Bear in mind that the settings vary, depending on the server type selected. Underneath we will describe the settings configuration for 'OVH VPS' and 'OVH Dedicated Servers' in details. Note that settings for 'So You Start' and 'Kimsufi' products are very much alike the 'OVH Dedicated Servers' once, so you may surely base on them while configuring these products. OVH VPS configuration settings: Solution Type - choose from the available the one that will suit your needs the most Operating System - choose the OS, it can still be reinstalled at any time if such an option is enabled for clients GNU/Linux Windows (Cloud/Cloud RAM only) License - you can select a license from the available ones Data Center Location - choose where the server shall be located on the OVH data center Payment Frequency - define the service payment frequency to pay for renewals before their expiry date. You can set it to manual renewal or choose an automatic renewal frequency: Auto - choose this option to correlate your payment frequency to OVH with the product billing cycle selected in WHMCS. Note that 'Triennially' billing cycle is not supported by OVH so keep it unavailable for the clients Monthly, Quarterly, Semi-Annually, Annually, Biennially - manually define the fixed payment frequency that will be set for the ordered product regardless of the billing cycle offered for clients in WHMCS Prevent System Reinstall - enable if you want to block the OS reinstallation during the upgrade process Snapshot - decide if clients should be allowed to capture an image of the server at a given time.

OVH Dedicated Server configuration settings: Operation System Template - choose a template of an operation system to install Operating System Language - choose the language of an installed operation system Plan - check out the powerful line-up of dedicated servers and select the preferred solution Disks - customise your server by selecting one of the available disks Distribution License - choose the distribution license Application License - choose the application license Contract Duration - define the duration of the contract Memory - define the memory of your dedicated server vRack - choose up to 40 Gbps, on certain models, for increased speed Public Network - choose the preferred public network traffic Data Center Location - define where a server will be located on the OVH data center Payment Frequency - define the frequency of payments

21. Afterward, set up incoming mail configuration. Due to API limitations, all emails with server credentials can only be sent to your OVH / Kimsufi / So You Start email address set in the panel. This applies to messages with credentials sent after creating the server as well as messages sent after reinstallation. The solution to this problem is email piping that will be used to receive messages sent to your OVH mailbox and then forwarded through the templates further to your WHMCS clients. Note: Even though the module filters the received messages in your mailbox, we recommend that you use a separate mailbox for your main OVH VPS and Dedicated Servers profile account to avoid any issues with non-OVH content. After setting up the dedicated mailbox, provide its valid credentials below and test whether the connection has been established correctly. Note: There is available an option to 'Disable Certificate Validation'. Please toggle this option ONLY if you are having trouble with the connection. The certificate validation will be omitted when connecting to an email box. Note: The 'Mailbox Folder' option allows you to define your mailbox folder for 'Incoming Mail Configuration' which will be used if received emails are set to be automatically filtered and moved to other than the default folder in the inbox.

The cron set during the last stage of the module's installation should periodically check that mailbox for OVH messages. If any new emails are received, they will be then converted to your email template and sent to the corresponding client. The default email templates for product creation, reinstallation and reboot in rescue mode can be specified below. Take a look at the Tips section - tip no 1, and check the templates' types.

22. Automation Settings section includes detailed actions that will be automatically performed by the module in several situations: Action On Service Suspension - decide what to do with the server in situation when the module command: Suspend has been triggered Stop (VPS) Do Nothing (VPS) Do Nothing (Dedicated Server) Reboot To Rescue (Dedicated Server) Terminate (Dedicated Server) Reinstall (Dedicated Server) Auto Pay With Preferred Method - toggle to make payments for orders automatically with a preferred payment method in OVH Panel Auto Assign VPS/Dedicated Server To Reusable On Termination - when terminated, the server will be in fact cleared and added to the queue to be selected as a reusable by other clients Waive Retractation Period - toggle to resign from the withdrawal period on OVH orders

23. The following section is dedicated to the Client Area Features. You will find here numerous options that can be enabled and then will be available to your clients in their client area. Please note that some options are available for VPS only, Dedicated Server only and some for both of them: Disks (VPS only) - if enabled, clients are allowed to view disks attached to their servers with specified limits Reinstall - if enabled, clients are allowed to reinstall the server in the client area KVM/IPMI Console - if enabled, clients are allowed to manage their server using KVM console Service Information - decide which records will be visible in the client area. Please remember that if you do not choose anything, all records will be displayed in the client area. Rescue Mode - if enabled, clients are allowed to reboot the server in rescue mode IP Addresses - if enabled, clients are allowed to view IP addresses assigned to the server Update Reverse DNS Paths - if enabled, reverse DNS can be updated in the client area, 'IP Addresses' must be previously enabled to use his option Traffic Statistics Graph (Dedicated Server only) - if enabled, clients are allowed to view traffic graph Important: Access to KVM/IPMI Console and Traffic Statistics Graph is available for OVH only. "Kimsufi" and "So You Start" brands do not support them.

24. At the end of the configuration process, you can decide whether you want to generate configurable options for the product. Configurable options can be used by your clients to select each Server parameters individually during order placement. Otherwise, if configurable options are not defined, then the fixed parameters specified in the earlier configuration will be used instead. Configurable options for OVH Dedicated Servers: dedicatedSystemTemplate|Operating System Template dedicatedLanguage|Operating System Language Configurable options for OVH VPS server type: product|Solution Type systemVersions|Operating System Template localisation|Data Center Location license|License snapshot|Snapshot

If you decide to use configurable options, press on the 'Create' button and select which options you want to generate. 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.

Generating Additional Configurable Option

This section presents how you can manually add 'Solution Type & Operating System & Application' as additional configurable option in order to provide the diversity of your products. Proceed to 'System Settings' → 'Configurable Options' . Click on the 'Configurable Options' that were generated previously.

Click 'Add New Configurable Option' as presented below.

Now, you need to provide 'planCodeVpsOsAddon|Solution Type & Operating System & Application' as 'Option Name' and choose 'Dropdown' as 'Option Type' . The first option has to be '0|None' .

You can add another 'Options' following this scheme: product:OS:license|your name that is displayed to customers As an example, we will provide 'vps-value-1-2-40:Centos 7 - cPanel:option-cpanel-1|VPS Value 1 vCPU 2 GB RAM 40 GB disk - Centos 7 - cPanel (Option cPanel 1 account)' .

If you wish to diversify your products, set different prices to make your products more competitive on the market. You can create another options using the following values.

Product	OS	License
vps-comfort-4-16-160	Archlinux	option-cpanel-100
vps-comfort-4-16-320	Centos 7	option-cpanel-200
vps-comfort-4-16-80	Centos 7 - cPanel	option-cpanel-30
vps-comfort-4-4-80	Centos 8	option-cpanel-5
vps-comfort-4-8-160	Centos 8 - Plesk	option-cpanel-1
vps-comfort-4-8-320	CoreOS Stable	option-plesk-webadmin
vps-comfort-4-8-80	Debian 10	option-plesk-webhost
vps-elite-8-16-160	Debian 10 - Plesk	option-plesk-webpro
vps-elite-8-16-320	Debian 8 - Docker	option-windows
vps-elite-8-16-640	Debian 8 - OpenVPN
vps-elite-8-32-160	Debian 8 - Plesk
vps-elite-8-32-320	Debian 8 - Vestacp
vps-elite-8-32-640	Debian 8 - Virtualmin
vps-elite-8-8-160	Debian 8 - WordPress
vps-elite-8-8-320	Debian 9
vps-elite-8-8-640	Fedora 31
vps-essential-2-4-160	Ubuntu 16.04
vps-essential-2-4-40	Ubuntu 18.04
vps-essential-2-4-80	Ubuntu 19.10
vps-essential-2-8-160	Ubuntu 20.04
vps-essential-2-8-80	Windows Server 2016 Standard (Desktop)
vps-value-1-2-40	Windows Server 2019 Standard (Desktop)
vps-value-1-2-80
vps-value-1-4-40
vps-value-1-4-80

Note: Please remember that the above options can be changed as plans are updated. You can easily check the currently available options by generating the default configurable options in the 'Module Settings' section.

Configuration of Addon

You have just correctly created and customized a new product. Go to 'Addons' → 'OVH VPS And Dedicated' in your WHMCS.

Servers

'Servers' section contains a list of your configured servers, you may quickly edit them directly from this site, simply press the edit icon.

In the next step, press the marked icon to see a list of deployed machines.

There you will see all existing machines on this very server. Whether they are used by any client already or not. Next to the machine name, there are details such as: its state displayed name assigned client (if there is any already) service assigned reusable toggle - for machines that can be used again by other clients without the necessity to terminate it first. If disabled, the machine can be simply terminated when not used. If enabled, when the product is created for the next time by the client, this machine will be automatically reinstalled and assigned to this client. In order to manually assign the machine to a client, simply press the marked on the screen button.

Start typing to see a list of clients, then select existing service to assign.

There is also a possibility to assign reusable products to the machine. These products will be permitted to use this machine.

Logs

Go back to 'Logs' section, there you will see a list of all module actions, including errors, notifications etc.

Management

Admin Area

OVH VPS & Dedicated Servers For WHMCS allows you to monitor and manage your customer servers from the admin area of your WHMCS system. This includes supervision of such features like: Module commands and service actions that enable you to manage server status and features Service information which provides you with the current status, resources and options set for the server

OVH VPS type Service Monitoring section with current statuses Created snapshot with a direct option to edit, restore and delete it List of IP addresses with option to update the reverse DNS path List of disks with any important details

OVH Dedicated Servers type: List of IP Addresses with option to update the reverse DNS path Traffic statistics graph

Ordering

Owing to configurable options, you are able to offer a product which your clients can tailor according to their needs. Additionally, you are able to set up pricing for each configurable option, which makes your offer even more competitive. After the order placement and successful VM creation, the server credentials will be sent to the client's email address according to the set cron execution intervals.

Importing Existing VPS

In this section, you can find short instruction on how to connect one of your clients to your already existing VPS in the OVH panel. Take the following steps to make sure that the process will be carried out properly. 1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary, view click on the ' Add New Order' button. Next, select a 'Product/Service' and press 'Submit Order' . What is important, do not perform the 'Create' action. The status has to remain as 'Pending' . More info about placing orders can be found here 2. Proceed to the newly created product's card in your admin area. Find the following empty field: Server Name The above-mentioned information has to be consistent with the data from your OVH panel. Now, complete this field as presented below. Important! Remember to make sure that the format of the provided data is compatible with the format supported by the module. You can preview it for another product of the module you have already created and enter it in a similar way. If you completed the required data, now change the status from 'Pending' to 'Active' and 'Save Changes' .

3. If the completed data is correct, after refreshing the page, you will see the attached VPS from OVH. Important! Remember to manually add other missing parameters of the VPS such as domains, IP Addresses, configurable options, etc. so they match the parameters of the attached VPS from the OVH panel.

Client Area

Client area interface of 'OVH VPS & Dedicated Servers' should look like the one on the screen below. As you can see, the control panel contains useful options required for managing a server. The module allows your customers to easily power on/off, reboot and reboot in rescue mode, reinstall and access console through pressing the corresponding buttons. Clients can also view disks, create and restore snapshots, see IP addresses and view current traffic graphs. Additionally, clients may view the current server parameters, resources as well as the assigned IP addresses. OVH VPS client area view:

OVH Dedicated Server client area view:

Service Actions

Access Console

In case of OVH VPS, clients might be granted access to KVM console. Simply press its icon to open the console window.

For OVH Dedicate Servers, there is supported IPMI console. Press the IPMI Access icon and then select type and TTL of the IPMI access to continue to the console.

Rescue Reboot

This action reboots the server in the rescue mode. The moment you press the confirm button, new login details are sent in an email template selected in the product configuration (see point 21), with accordance to the cron settings. Note: The action might last up to a few minutes, please be patient.

Reinstall

The action when triggered, causes the new login details to be sent in an email template selected in the product configuration (see point 21) and with accordance to the cron settings. Note: Please be patient as reinstallation process is quite time consuming.

Service Management

Snapshot (VPS)

Use snapshots to save the current contents of the virtual machine memory. You may use them later to restore the VM's settings. Note: Creating a snapshot may take a while, so it will not appear on the list right away.

Allowed actions on the created snapshot: Edit the snapshot (description) Restore the snapshot to reverse the saved contents of the VM settings Delete the snapshot Create another snapshot. Note: Keep in mind that you must have previously deleted the existing snapshot, as only one snapshot may exist at the time.

Disks (VPS)

When you enter this section, you will see a list of assigned disks with any details on them, such as: Type Size Bandwidth limit Free space threshold Status

IP Addresses

Under 'IP Addresses' you may see any assigned IP addresses, their version, type, location, MAC address and reverse DNS if specified. (1) Update the reverse DNS path of an IP address by pressing the marked button. (2) Manage the firewall rules. (3) Turn on the firewall.

(1) - Provide a new reverse DNS for the selected IP address. Press 'Confirm' when ready.

(2) - Manage existing firewall rules, preview their priority and other details, delete if necessary.

Add a new firewall rule by pressing appropriate button. A new window with rule details to be filled out will appear.

Traffic Statistics Graph (Dedicated Servers)

Open this section to see the graph with traffic statistics. You will find there outlined data on errors, packets and traffic downloads as well as uploads. You may easily adjust the graph's view by changing the time scope of the displayed stats. Note 1: Some of the mentioned option may not be visible on the graph until soma data are generated. This is applicable to the graph itself as well. Note 2: "So You Start" and "Kimsufi" brands may not support graphs.

Select the time scope:

Tips

1. List of 'OVH VPs & Dedicated Servers' email templates included in the module: OVH VPS Has Been Created OVH VPS Rescue Reboot OVH VPS Reinstalled OVH Dedicated Reinstalled OVH Dedicated Server Rescue Reboot In order to view the templates' content and edit it, please move to WHMCS → System Settings → Email Templates. More detailed information on templates can be found in the official documentation. 2. If you want to block specific OS images which are available for the server reinstallation process, you need to add these OS images to the following file: yourWHMCS/modules/servers/OvhVpsAndDedicated/app/Config/blockedImages.json

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.

2. You may encounter problems while configuring the product for the dedicated server type for 'So you Start' or 'Kimsufi' brands. As a consequence, options such as plan to configure in the module settings can be unachievable. Please note that this is most probably caused by API problems on the side of these brands. However, it is still possible to assign the ordered server directly from the panel of these brands to the client's product at WHMCS by providing its 'Server Name' in the ordered service in the admin area.

3. If you encounter error in logs: Error during create for service #name_of_your_service. Message: Your preferred payment method is not valid Solution: Please log into your OVH panel and set up a default payment method there.