...
Excerpt |
---|
|
DirectAdmin is a graphical web-based web hosting control panel designed to make administration of websites easier. |
Table of Contents |
---|
Table of Contents |
---|
maxLevel | 4 |
---|
minLevel | 2 |
---|
outline | true |
---|
class | toc |
---|
|
|
About DirectAdmin
DirectAdmin is a graphical web-based web hosting control panel. Learn more about DirectAdmin on their website at https://www.directadmin.com.
Supported Features
Create | Cancel | Suspend | Unsuspend | Management | Config Options |
---|
| | | | | |
Installing DirectAdmin
To install the DirectAdmin module, visit [Settings] > [Company] > [Modules] > Available, and click the "Install" button for DirectAdmin.
...
Enter the details for your DirectAdmin server.
Image Removed
Image Removed
Image Added
Field Name | Description |
---|
Server Label | Enter a label for this DirectAdmin server, it can be anything you like. |
Host Name | Enter the FQDN hostname for your DirectAdmin server, i.e. "directadmin.domain.com". |
Port | The port for your DirectAdmin server. Defaults to 2222. |
Username | Enter your DirectAdmin username. This is the username you would log into DirectAdmin with. |
Password | Enter your DirectAdmin password. This is the password you would log into DirectAdmin with. |
Use SSL when connecting to the API | Check this option to use SSL for all API requests to your DirectAdmin server. This is highly recommended. |
Account Limit | Enter the maximum number of accounts that should be added to this DirectAdmin server. |
Name Servers | Enter the name servers that should be used for this server. These will be available to the package welcome email to the client. |
Notes | Enter any notes that pertain to this server for future reference. |
After filling out these options, click "Add Server" to add your DirectAdmin server.
...
To add a server group, from the DirectAdmin overview at [Settings] > [Company] > [Modules] > DirectAdmin, click "Add Server Group", then enter the details.
Option | Details |
---|
Group Name | Enter the name for this server group. |
Add Order | Choose how servers in this group will be selected for provisioning. Currently, first non-full server is the only add order. |
Assigned Servers | Select servers under "Available Servers" and click to move them to the left column to add them to the group. |
Creating Packages
Packages define the pricing, welcome email, module and more. Packages can be assigned to Package Groups, and added to Order Forms. To create a Package, visit [Packages] > Browse, and click the "Create Package" button.
...
The Basic section consists of the following options:
Image RemovedImage Added
Field Name | Description |
---|
Package Name | Enter the name of this Package, it will be visible wherever services are listed and on any order forms. A separate name can be defined for each language in the system. |
Description | Enter a Description for this Package. HTML is allowed, and descriptions appear on order forms. A separate name can be defined for each language in the system. |
Status | "Active" is the default, "Inactive", and "Restricted" are also available. |
Quantity Available | If this Package has a limited quantity available, enter the quantity, or leave it as "Unlimited". |
Description | Enter a Description for this Package. HTML is allowed, and descriptions appear on order formsUse renewal prices for package upgrades | When enabled, upgrading to this package will use renewal prices if they are set. The same will apply to any configurable options that are altered in the upgrade. The regular price that will be used in this setting is disabled. |
Configurable Options | Select the Configurable Option Group you created previously, to make those options available for this package. |
Module | Select "DirectAdmin" for the module. |
Module Options
The Module Options section consists of the following options, which are specific to PleskDirectAdmin:
Field Name | Description |
---|
Server Group | Select "Any" if you wish to specify a specific server, or select the Server Group to provision from. Selecting a group means that accounts will be provisioned from the group. Selecting a group is recommended. |
Server | If "Any" is selected above, select the server this package will use to provision accounts. |
Account Type | Select the appropriate account type, i.e. "User" for standard hosting accounts. |
DirectAdmin Package | Select the DirectAdmin Package to use when configuring accounts. These values are pulled from "Plans" created in DirectAdmin and specify resources for the plan. |
IP Address | Select the IP Address you would like to create the accounts on. |
Pricing
Image RemovedImage Added
Field Name | Description |
---|
Term | Enter the term for the desired pricing option. For example, if you wish to create a 3 month pricing option, enter 3 here. |
Period | Select the period for this pricing option. "Day", "Week", "Month", "Year", and "One time" are options. The client will be invoiced every "term period", for example every 3 months if 3 is entered for term, and Month is selected for period. |
Currency | Select the currency this pricing option is available for. |
Price | Enter the price for this pricing option. |
Renewal Price | If enabled, the renewal price will be used for service renewals and possibly prorated service changes, depending on the setting above. |
Setup Fee | If there is a setup fee, enter it here. |
Cancellation Fee | If there is a fee to cancel early, enter it here. |
Click the "Add Additional Price" to add more pricing options. It's common for people to create 1 Month, 3 Month, 6 Month, and 1 Year price options. There are many possible combinations.
...
When creating or editing a package that uses this module, the following tags will be available:
Tags | Description | Notes |
---|
{module.host_name} | The host name of the server that the service was provisioned on | e.g. "domain.com" |
{module.name_servers} | An array of available name servers for this module | Array elements must be looped over in the email template. See below for an example. |
{package.type} | The package meta type | e.g. "standard", "user", "reseller", etc. |
{package.package} | The package meta package name | e.g. "Bronze" |
{package.ip} | The package meta IP address |
|
|
{service.direct_admin_username} | The service field for the DirectAdmin account username |
|
|
{service.direct_admin_password} | The service field for the DirectAdmin account password |
|
|
{service.direct_admin_domain} | The service field for the DirectAdmin domain | e.g. "domain.com" |
{service.direct_admin_ip} | The service field for the DirectAdmin IP address | e.g. "shared", "assign", or an IP address |
{service.direct_admin_email} | The service field for the DirectAdmin email address |
Displaying Name Servers in the Welcome Email
...
Code Block |
---|
|
$this->apiUrl = rtrim($url, "/") . ":2222"; |
Change maximum username length
By default Directadmin usernames must be between 4 and 8 characters in length. You can change this by editing /components/modules/direct_admin/direct_admin.php, and within the method "getServiceRules", look for and update the following code block, changing the "8" to the new desired length limit.
Code Block |
---|
|
'length' => [
'if_set' => true,
'rule' => ['betweenLength', 4, 8],
'message' => Language::_('DirectAdmin.!error.direct_admin_username.length', true)
] |
Common Issues
- "That IP does not exist in your list"
- This can happen after changing the IP of your DA server. Resave each DA package to resolve.