Personal tools
Namespaces

Variants
Actions

DirectAdmin Extended For WHMCS

From ModulesGarden Wiki
Revision as of 08:58, 2 October 2015 by Karolina (Talk | contribs)

Jump to: navigation, search

Contents

About DirectAdmin Extended For WHMCS

DirectAdmin Extended For WHMCS addon module allows your customers to manage DirectAdmin accounts without even leaving your website!

The most commonly used DirectAdmin functionality has been relocated directly to the WHMCS client area.
Management of FTP, subdomains, databases, SSL certificates, backups and more has never been so convenient and easy!

  • Admin Area Features:
✔ Configure Client Area Features Per Product
✔ Choose Application Auto Installer To Use Per Product - Softaculous And Installatron
✔ Assign Configurable Options To Application Auto Install
✔ Assign Custom Fields To Application Auto Install
✔ Issue Module Commands Create/Suspend/Unsuspend/Terminate
✔ Change Password And Package Of Products
✔ Log In To Each cPanel Account On Click
✔ Define FTP Backups End-Points
✔ Define Backup Directory Paths
  • Client Area Features:
✔ Your Account
✔ FTP Accounts
✔ Databases
✔ Subdomains
✔ Addon Domains
✔ Backups
✔ File Manager
✔ Statistics
✔ E-Mail Management
✔ Emails
✔ Email Forwarders
✔ Autoresponders
✔ Vacation Messages
✔ Mailing Lists
✔ SPAM Filters
✔ Spamassasin Setup
✔ Advanced Features
✔ Cron Management
✔ Apache Handlers
✔ Error Pages
✔ SSL Certificates
✔ Parked Domains
✔ Site Redirections
✔ Log In To
✔ DirectAdmin
✔ Webmail
✔ phpMyAdmin
✔ Install/Delete/Backup Applications via Auto Installer
✔ Display Account Usage
✔ Change Password
✔ Password Generator Functionality
  • General Info:
✔ Functionality For Automatic Suspension Of Accounts Upon Reaching The Bandwidth Limit
✔ Multi-Language Support
✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V5 and V6

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 your client area and download DirectAdmin Extended For WHMCS.
DA 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like these.

DA 2.png
3. When you install DirectAdmin Extended for the first time you have to rename 'license_RENAME.php' file.

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

DA 3.png
4. 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'.

DA 4.png

Addon Activation

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

Log in to your WHMCS admin area. Click 'Setup' then choose 'Addon Modules'.
Afterwards, find 'DirectAdmin Extended Functions' and press 'Activate' button.

DA 5.png
6. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

DA 6.png
7. Well done! You have just successfully installed DirectAdmin Extended For WHMCS!

Now, in your WHMCS system press 'Addons' then press 'DirectAdmin Extended Functions'. You will see a following screen.
Let's proceed to configuration of your freshly installed module.

DA 7.png

Server Configuration

8. Now we will show you how to configure a new product.

To do so log in into your WHMCS and go to 'Setup' 'Products/Services' 'Servers'.
Afterwards press 'Add New Server'.

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

Here you can also provide other server details like nameservers or the maximum number of accounts.

DA 9.png
10. After you configure your server correctly, you will see a following screen.

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

DA 10.png
11. Enter name, click on your previously created server, press 'Add' then press 'Save Changes'.
DA 11.png

Product Configuration

12. In order to create and configure product, click on 'Setup' 'Products/Services' 'Products/Services'.

If you do not have a product group, click on 'Create a New Group'. If you do, simply move to step number 14.

DA 12.png
13. Enter product group name and press 'Save Changes'.
DA 13.png
14. When you have a product group, you can create your product and assign it with DirectAdmin Extended. If you already have a product, jump to step 16th.

To create a product click on 'Create a New Product'.

DA 14.png
15. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
DA 15.png
16. Now you need to move to 'Module Settings' section, choose both 'DirectadminExtended' and your previously created server group from dropdown menus.

Enter your 'Package Name' and choose your 'Reseller IP' if required. DirectAdmin Extended won't work properly without specified package name.
You can also activate the functionality 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.

DA 16.png

Addon Configuration

17. Go to 'Addon Modules' 'DirectAdmin Extended Functions' and click on 'Features' button.
DA 17.png
18. In the newly opened window, tick the features you would like to activate for your customers and choose the webmail from a dropdown menu.

Afterwards, press on 'Save Changes' button.

DA 20.png
19. (Optional) You can define FTP backup path under 'FTP Backups End-Points'.

Simply, fill out form with 'Backup Name' , 'Host' , 'Port' , 'User' , 'Password' and 'Path to Files'.
Afterwards, save it through pressing 'Save' button.

DA 21.png
20. (Optional) Now, under Backup Directory Path enter backup path which can be found in your DirectAdmin server → 'Admin Backup/Transfer' 'Local' textbox.
DA 22.png
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 their client area.

DA 23.png

Management

DirectAdmin Extended allows your customers to manage their DirectAdmin accounts via client area in your WHMCS system.

In this short guide we 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.

Install Apps

Manage your applications straight from WHMCS client area.

Install new applications, create backups if needed and delete unused apps.

DA 23 1.png

FTP Accounts

Manage FTP Accounts in the easiest possible way. Type in your login, generate a new password and select directory.

Manage the accounts to be able to access your website files through an FTP protocol.

DA 24.png

Databases

Owing to MySQL Management you can create/delete new databases and users. You can also add users to particular databases and set up privileges.
DA 25.png

File Manager

'File Manager' option allows you to view and manage files and folders on your DirectAdmin account.

You may also upload new files and manage permissions.

DA 26.png

Subdomains

Create subdomains for your website sections. Just choose domain from the list of available domains and type in subdomain name.
Once created modify or remove the subdomain if needed.
DA 27.png

Addon Domains

Add and manage your addon domains.

Note! Make sure Addon Domains feature has been enabled for your account before using it!

DA 28.png

Backups

This tab allows you to backup your DirectAdmin user account.

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

DA 29.png
Our module allows you to restore your backups, you can do it through pressing ' Restore' (1) button next to backup.

You can also recreate account with setting saved in backup. To do so, press 'Recreate' (2) button.
To delete backup simply press 'Remove' (3).

DA 30.png
In order to view and use backup made by administrator, select its location from an 'Admin / reseller backups location' dropdown menu and press 'List files' button.
DA 31.png

Statistics

Proceed to 'Statistics' section in order to check and analyze some presented data.
Control usage level for each setting here.
DA 32.png

E-Mail Management

E-mail management section includes all tools related to emails. Go through them to learn more.

Emails

Create/edit/delete email accounts that are associated with your domains. Use filter to find required email address.
DA 33.png

Email Forwarders

In addition to managing email accounts, you are allowed to create and delete email forwarders either.
DA 34.png

SPAM Filters

SPAM Filers give to you possibility to define SPAM settings such as:
  • block email address
  • block email domains
  • block email with chosen word
  • block email longer than specific value
  • define action for blocked emails
  • adult filter
DA 35.png

Autoresponders

This page enables you to set up autoresponders to email boxes from this DirectAdmin accounts.

Autoresponder replies to each email received by the email box.

DA 36.png

Vacation Messages

Vacation Messages is similar to Autoresponders shown above.

The only difference is that vacation message replies only to the first email received per email address.

DA 37.png

Mailing Lists

On this page you can configure your mailing lists.

Creating a new mailing list starts by providing its name.

DA 38.png
Afterwards, you can alter its settings.
DA 39.png
From here you can add new subscriber and digest subscribers as well as remove existing ones.
DA 40.png

Spamassasin Setup

On this page you can configure your Spamassasin.

You can set up:

  • Action performed on spam emails
  • Threshold
  • Define separete actions for spam emails of above defined threshold
  • Define whether to change spam email subject or leave it intact
  • Choose how spam should be delivered
  • Specify blacklisted email addresses
  • Specify whitelisted email addresses
DA 41.png

Advanced Features

Advanced tools used to configure sophisticated settings of your account.

Parked Domains

In 'Parked Domains' section you may manage your aliases and pointers.
Have access to the content of one domain from another one!
DA 46.png

Site Redirections

Easy access to site redirections is very useful. Within a few seconds, you can redirect the page to point to another.
DA 47.png

Cron Management

Cron Jobs Management allows you to easily add and remove your cron jobs.

Choose its specific timing and type in the command to be executed.

DA 42.png

SSL Management

This feature moves completely the management of your Private Keys, CSR Keys and SSL Certificates into your WHMCS client area.

Here you can conveniently manage all the aspects of your SSL Certificates without the necessity to log in to your Direct Admin account.

DA 45.png

Apache Handlers

Under 'Apache Handlers' page you can define custom handlers for chosen file extensions or specific files.
DA 44.png

Error Pages

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

Here you can define HTML code of error pages displayed during 401, 403, 404 and 500 errors.

DA 43.png

Install Applications

Install apps is a very interesting and time saving feature of DirectAdmin Extended. In 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 Functions'.
Press 'Install apps' button, afterwards, mark 'Install App' checkbox, select autoinstaller from a dropdown menu (you can choose 'Installatron' or 'Softaculous' ).
You can also choose desired language of the application by entering value into the 'Language' field. Complete list of language codes can be found here.
If the field is left blank, the default value 'en' (english) will be used.
Finish setting it up by marking 'Install Button' and 'Backup Button'. Save through pressing 'Save' button.

DA 48.png
To see available applications list, simply click on 'Install Applications!' then click on 'Install New' button as shown on the following screen.
DA 49.png
Afterwards you will see an extensive menu of application categories. For presentation purposes we will install 'Wordpress' located at 'Content Management'.
DA 50.png
Let's enter 'Content Management' category and press the button 'Install Now!' next to 'Wordpress'.
DA 51.png
Now you can enter necessary installation details and press 'Install Application' when ready.
DA 52.png
If the installation process has been successful you will see a message as shown on the screen below.
DA 53.png
From now on, you can check the status of your application by clicking 'Install Applications!' on the left side menu.
DA 54.png

Management of Autoinstalled Apps

To set up DirectAdmin Extended product with autoinstalled app, follow these steps:

In the beginning go to 'Product/Services', find your product connected with cPanel Extended and enter '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 'Show on Order Form'. Everything is shown on the screen below.
Note 1: 'Site Description' is needed only for Softaculous autoinstaller.
Note 2: 'Database Name', 'Database Username' and 'Database Password' fields do not need to be filled upon ordering product by client.
If they are not filled, database will be automatically generated.
Note 3: For Installatron autoinstaller use 'Site Title' in place of 'Site Name'.

DA 55.png
Afterwards, go to 'Addons' 'DirectAdmin Extended Functions' 'Install Apps'.

Mark 'Install App'. select auto installer and app to install from dropdown menus. Confirm through pressing 'Save' button.

DA 56.png
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.

DA 56 1.png

Assignment of Configurable Options To Application Autoinstall

With help of its functionality you can let your clients decide which application they would like to install on their new DirectAdmin account.

While placing an order your customer chooses application and along with account creation this very application will be installed on the account.
There is nothing else you need to do. Application will be instantly ready to use!
To set up this feature go to 'DirectAdmin Extended Functions' , press 'Install Apps', tick 'Install App', 'Assign To Configurable Options' and choose 'Auto Installer'.
Save these settings through pressing 'Save Changes' and click on a floppy disk icon to download the list of apps.

DA 57.png
These are the names of values that you can enter in configurable options fields which we will configure in the next step.

For example, if you would like to set up '4images' in your applications list, you will need to enter value '4images 1.7.11'.
1. If you make a mistake with the application name, the autoinstall will not work.
2. If you do not enter the version number, the autoinstall will install the latest version of the application.
Now, when you know what values should be entered in configurable options for particular applications, we can proceed further.

DA 58.png
Go to your WHMCS → 'Setup' 'Products/Services' 'Configurable Options' and press 'Create a New Group'.
DA 59.png
Enter 'Group Name' by your choice, select product you want to assign configurable options to, then press 'Save Changes'.
DA 60.png
Now click on 'Add New Configurable Option'.
DA 61.png
This moment is very important. As an 'Option Name' , you have to type in 'Installation App'. In other case entire functionality will not work.

Here you can set up as many applications as you want. To do so enter the name of value e.g. 'Wordpress 3.7.1' and press 'Save Changes'.
Repeat this as many times as you need and do not forget to set the 'Option Type' to 'Dropdown'.

DA 62.png
As you can see on the following screen we decided to offer our customers 5 applications.

When you finish adding applications press 'Save Changes' and 'Close Window'.

DA 63.png
Afterwards go to 'DirectAdmin Extended Functions' , tick 'Assign To Configurable Options' and choose 'Applications' from a dropdown menu.

Please note that you can have more configurable options groups. Press 'Save Changes' and that's it. You have just successfully assigned configurable options to application autoinstall.
Let's check out what your customers are going to see in their client area while placing the order.

DA 64.png
As you can see a dropdown menu with our previously set up applications has shown up.
DA 65.png

Backups Management For Apps

You can also create a backup of your installation. It is very easy! To do so click 'Create Backup'.
DA 66.png
After a few seconds you should see a 'Success' message as a confirmation of the operation performed.

To manage your backups simply press 'Backups'.

DA 67.png
Here you can quickly view, delete or restore your existing backups.
DA 68.png

Log In To DirectAdmin

With a single click of a button 'Log In To DirectAdmin' you can log in to your DirectAdmin without necessity of entering login details.
DA 69.png

Log In To Webmail

You can easily log in to your webmail by clicking 'Log In To Webmail' .
DA 70.png

Log In To PhpMyAdmin

In order to enter phpMyAdmin, press 'PhpMyAdmin' button as shown on the following screen.
DA 71.png

Management of Resource Usage

At product overview tab you can find your product current resource usage and limits assigned to the product.
DA 72.png

Management of Existing Products

You can easily use DirectAdmin Extended module with your already configured DirectAdmin products.

To do so change type of servers and module names of products from 'Directadmin' to 'DirectadminExtended' .
Additional information about how to correctly configure your servers and products you can find at points 8-16 in 'Installation and Configuration' section.

Management of Billing

When you combine DirectAdmin Extended For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options.

Module allows you to charge your customers based on the server resources used by them.

DA 73.png
With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
DA 74.png

Tips

1. Keep in mind that user packages and reseller packages are two different things.

When you configure a typical product for your customers in the WHMCS, you would usually need to enter one of your user packages, not the reseller packages.

2. To manage SSL certificates, your customers require an owned IP.

In other case module will return the following error: 'You can manage SSL certificates when you own the IP you are using. Info for admins: Assign an owned IP.'

DA 75.png
To add owned IP, log in to your DirectAdmin admin area, go to 'IP Management' section, add the IP and assign it to the admin.
DA 76.png
Afterwards manage the user for whom you want to add the IP.

Set IP to your previously created IP, save changes and make sure that this IP will be current IP of your customer.

DA 77.png
If you add more IP addresses with free status in your DirectAdmin, you can quickly assign those IP addresses to your customers in WHMCS.

For this purpose, simply type the IP in the 'Dedicated IP' field, press 'Enter' on your keyboard and update the product package through clicking on 'Change Package' button.

DA 78.png

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If you have problems with connection make sure that port 2222 is open.
3. If after installation, you get an ionCube encoder problem (wrong version), please open a support ticket.

We will provide you with different version of the module encrypted with the older version of ionCube.

4. You cannot change direct admin port to other than 2222, due to WHMCS DirectAdmin module limitation.

DirectAdmin Extended For WHMCS rely on default WHMCS DirectAdmin module.

Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
DirectAdmin Extended For WHMCS