Difference between revisions of "Hosting Modules"

From AWBS Wiki
Jump to: navigation, search
(→‎Cpanel Specific Configuration)
(→‎Sub Domain Hosting)
 
(120 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
==Table of Contents==
 +
# [[#Hosting_Configuration_-_Read_First.21|Hosting Configuration - Read First!]]
 +
# [[Cast_Control_Specific_Configuration|Cast Control Module]]
 +
# [[CentovaCast_Specific_Configuration|CentovaCast Module]]
 +
# [[Cloudmin_Specific_Configuration|CloudMin Module]]
 +
# [[cPanel_Specific_Configuration|cPanel Module]]
 +
# [[cPanel_with_WHMSonic|cPanel with WHMSonic Module]]
 +
# [[DirectAdmin_Specific_Configuration|DirectAdmin Module]]
 +
# [[DotNetPanel_Specific_Configuration|DotNetPanel Module]]
 +
# [[eNom_Hosting_Specific_Configuration|eNom Hosting Module]]
 +
# [[Ensim_Specific_Configuration|Ensim Module]]
 +
# [[GameCP_Hosting_Specific_Configuration|GameCP Module]]
 +
# [[Helm_Specific_Configuration|Helm Module]]
 +
# [[Hostopia_Specific_Configuration|Hostopia Module]]
 +
# [[HyperVM_Specific_Configuration|HyperVM Module]]
 +
# [[Interworx_Specific_Configuration|Interworx Module]]
 +
# [[ISP Manager_Specific_Configuration|ISP Manager Module]]
 +
# [[Kloxo_Specific_Configuration|LxAdmin/Kloxo Module]]
 +
# [[Plesk_Specific_Configuration|Plesk Module]]
 +
# [[SolusVM_Specific_Configuration|SolusVM Module]]
 +
# [[TCAdmin_Specific_Configuration|TCAdmin Module]]
 +
# [[Teamspeak_Specific_Configuration|Teamspeak Module]]
 +
# [[Teamspeak_3_Specific_Configuration|Teamspeak 3 Module]]
 +
# [[VDS Manager_Specific_Configuration|VDS Manager Module]]
 +
# [[VirtualMin_Specific_Configuration|VirtualMin Module]]
 +
# [[VPSnet_Specific_Configuration|VPS.net Module]]
 +
# [[WHMPHP_Specific_Configuration| WHMPHP Module]]
 +
# [[Zervex_Specific_Configuration|Zervex Module]]
 +
# [[#Alternate_Order_Wizard|Alternate Order Wizard]]
 +
# [[#Sub_Domain_Hosting|Sub Domain Hosting]]
 +
# [[#Load_Balancing|Load Balancing]]
 +
 
== Hosting Configuration - Read First! ==
 
== Hosting Configuration - Read First! ==
 
In the AWBS Configuration, Module Setup page, make sure you have enabled all hosting control panels that you will use/configure.
 
In the AWBS Configuration, Module Setup page, make sure you have enabled all hosting control panels that you will use/configure.
Line 6: Line 39:
 
'''>>Do the following in order to setup the structure for your hosting configuration properly.<<'''
 
'''>>Do the following in order to setup the structure for your hosting configuration properly.<<'''
  
−
1. Setup server groups. Use the server groups to form load balancing groups and/or categories. Example: put all cpanel servers in group1 and all helm servers in group2.
+
#Setup server groups. ([[Media:ServerGroup.png|''Screenshot'']])<br /> Use the server groups to form load balancing groups and/or categories. Example: put all cpanel servers in group1 and all helm servers in group2.<br />''Note: You must have at least one server group.''
−
 
+
#Setup your server(s). Add all hosting servers you will be setting up client hosting on. Select the correct server group. Refer to the specific control panel configuration pages for detailed help for your server type.
−
''Note: You must have at least one server group.''
+
#Go back to server groups and select a default server for each group and save. Save the record even if the correct group shows up.
−
 
+
#Setup hosting package types. These types will categorize your hosting plans in groups to be displayed together on a web page for ordering. Create a hosting package type for each web display page you want on your site. <br />''Hint: Once you have setup a type, you can click to edit and you will find a link to use on your menu for that type's display page.''
−
2. Setup your server(s). Add all hosting servers you will be setting up client hosting on. Select the correct server group. Refer to the specific control panel configuration pages for detailed help for your server type.
+
#Setup your hosting plans in the hosting plan setup page. Refer to the hosting control panel specific configuration pages for detailed help for setting up your plans correctly.
−
 
+
−
3. Go back to server groups and select a default server for each group and save. Save the record even if the correct group shows up.
+
−
 
+
−
4. Setup hosting package types. These types will categorize your hosting plans in groups to be displayed together on a web page for ordering. Create a hosting package type for each web display page you want on your site.
+
−
 
+
−
Hint: Once you have setup a type, you can click to edit and you will find a link to use on your menu for that type's display page.
+
−
 
+
−
5. Setup your hosting plans in the hosting plan setup page. Refer to the hosting control panel specific configuration pages for detailed help for setting up your plans correctly.
+
  
 
'''TEST'''
 
'''TEST'''
  
−
Place a test order for hosting using your test user account (create an account for testing if you did not already). Log back in as admin, go to the job queue. Your new order should be in the open job queue if you have 'Process all hosting orders immediately' set to True in the System Options area. The new order will show up in the pending queue if you have 'Process all hosting orders immediately' set to False in the System Options.
+
*Place a test order for hosting using your test user account (create an account for testing if you did not already).  
−
 
+
*Log back in as admin, go to the job queue. Your new order should be in the open job queue if you have 'Process all hosting orders immediately' set to True in the System Options area. The new order will show up in the pending queue if you have 'Process all hosting orders immediately' set to False in the System Options.
−
Click the run link to the left of the new order in the job queue to manually process the order. A popup window will open and display the progress of the communication to the hosting server. If all is configured properly, the hosting account will be created on the hosting server and the user account will receive an email notifying them their hosting account is active and give them login details as per the email template you have assigned to the hosting plan in the hosting plan configuration page.
+
*Click the run link to the left of the new order in the job queue to manually process the order. A popup window will open and display the progress of the communication to the hosting server. If all is configured properly, the hosting account will be created on the hosting server and the user account will receive an email notifying them their hosting account is active and give them login details as per the email template you have assigned to the hosting plan in the hosting plan configuration page.
  
 
If there are any errors, you can click to edit the job and check the 'return' field for any errors reported by the hosting server's API. To get more information for troubleshooting, you can place the job queue in debug mode by clicking the debug mode link at the top of the job queue, then run the job again. Details of the communication will appear in the popup window when the job runs in debug mode. It is recommended to leave debug mode set to off unless you need to troubleshoot a problem/error.
 
If there are any errors, you can click to edit the job and check the 'return' field for any errors reported by the hosting server's API. To get more information for troubleshooting, you can place the job queue in debug mode by clicking the debug mode link at the top of the job queue, then run the job again. Details of the communication will appear in the popup window when the job runs in debug mode. It is recommended to leave debug mode set to off unless you need to troubleshoot a problem/error.
  
−
== Cpanel Specific Configuration ==
+
== Alternate Order Wizard ==
−
#Setup Server Group(s) as desired.
+
(Note: Alternate Order Wizard feature available version 2.8.0 and newer)
−
(See Hosting Configuration (Read First) page).
+
  
−
#Setup the CPanel server(s).
+
The alternate order wizard can be enabled for either hosting or dedicated server ordering (not both).
  
−
Go to Server Setup and click Add New.
+
The alternate order wizard uses the AWBS API, to use it you'll need to add your server's main IP to the Extended System Configuration, remote_list setting.<br />
−
Enter information asked for in the New Server Wizard.
+
(''If you see 'Domain not available' for all domain searches, you have not configured the API for access'')
−
When you have completed adding all Cpanel servers, go back to the server groups page and assign the correct default server.
+
−
(Save the groups even if they show the correct default server)
+
  
−
Below are some details for your assistance:
+
Enable the alternate order wizard on a per package basis by editing each hosting package you want to use the alternate order wizard and set the Use Alternate Order Wizard setting to True and save.
  
−
Server Name: Enter a server name for your reference in AWBS. Do not use spaces.
+
Enable the alternate order wizard on a per type basis by editing the hosting package type and set Use Alternate Order Wizard to True and save.
−
Server Group: Assign the server to the correct server group.
+
−
Server Type: Cpanel
+
−
Server IP: Enter the server's IP address
+
−
Server URL: Enter the url to the server. Example: http://my.cpanelserver.com
+
−
Server CP: Enter the url given to customers to login to their Cpanel account control panel
+
−
Example: http://my.cpanelserver.com/cpanel
+
−
Server Cost: Enter your cost for this server. Used for reports only.
+
−
Default NS1: Enter your Cpanel nameserver 1 here
+
−
Default NS2: Enter your Cpanel nameserver 2 here
+
−
Server User: Enter the Cpanel username here. (Reseller account username or root)
+
−
Server Access Key: Paste the Server Access Key obtained in WHM when logged in as the user listed in the 'Server User' field. Do not paste the remarks at the top and bottom of the server access key.
+
  
−
Update hosting list IPs: Check if you are changing an existing Cpanel server's IP address. This will update all existing hosting packages assigned to this server.
+
Menu links are available both in the hosting package type setup page and hosting package setup pages to use on your website or menu as desired.
  
−
Update hosting list Servers: Check if you are changing the server's servername. This will update all existing hosting packages assigned to this server.
 
  
−
Delete Record: Only check this box if you are deleting this server. Caution: do not delete a server that has plans and user packages assigned!
+
There are 3 settings in the order.php engine file.<br />
 +
$carton = "0"; // 0 - send customers right to the payment page (skip the cart), 1 - send orders to the cart
 +
$apiurl = ""; //(no trailing slash) if blank will use this url (complete if using a different url than your AWBS site)
 +
$emptycart = "1"; //Empty the cart prior to adding the new package? This will remove all items from the cart
  
−
#Configure your Hosting Package Types
 
  
−
Configure types for hosting packages. Each type will display a webpage for ordering.
+
'''''Note:'''
 +
The order.php engine file, template and includes are all '''open source''', edit as desired!''
  
−
Use additional types to create multiple hosting order pages. Most people use the types to group their various hosting plan types, i.e. linux hosting type 1, windows hosting type 2.
+
==Sub Domain Hosting ==
 +
Configuration >> Sub-Domain Hosting Setup >> [Add Record]
  
−
User Group: Should be Default unless you want this page only viewable by a different user group. (not the public)
+
Setup any domains you want sub domain hosting ordered for.
  
−
Server Group: Select the correct server group.
+
For any hosting packages you want to offer the sub-domain hosting for:
 +
Configuration >> Hosting Package Setup >> select desired package(s)
  
−
Description: Enter what you want displayed as the title on the web page with this type of hosting
+
Check the checkbox that says:
 +
Sub-Domain Ordering ALLOWED
  
−
Details1 Name - Details6 Name: Enter display text for the various specs for the plan type. This set of specs willl be used for all hosting plans in this type.
+
==Load Balancing ==
 +
Load balancing is used to have hosting accounts provisioned equally among a group of servers.
  
−
+
To activate load balancing for any server group, check the box that says:
 +
Activate Load Balancing
 +
in the Configuration >> Server Groups >> [desired server group] setup page.
  
−
Hint: Once you have added and saved a Hosting Package Type, you can click to view/edit it again and see the correct link to use on your menu for this web page.
+
AWBS will take new orders and check for the server in that group with the least number of accounts on it and provision to that server.
  
−
#Configure your Hosting Plans
+
''Notes:''
 +
Control panel types that support over bandwidth billing will pull the account numbers from the server stats data pulled from the servers.
 +
Control panel types that do not support the server stats data gathering will pull the account numbers from AWBS's hosting manager.
  
−
Visible: Check if you want this plan to display on the web page.
+
=== Alternate use of the Load Balancing system ===
 +
This will provision accounts based on user selection of '''server location''' (datacenter).
  
−
Default Plan: Check if this is the default plan for the type. Each type needs to have one default plan.
 
  
−
Default Term: Enter the default term you want to display when your customers order. If you have other terms, they will get a selection to change it. Make sure the default term is a configured and available term for the plan.
+
1) Assign all servers to the proper server location (Create locations as needed and note the ID for use below)
 +
''Configuration >> Server Locations''
  
−
Upgrade Group: Set the upgrade group. All plans in this group number will show up as selections when the customer chooses to upgrade their plan. All plans in the same group should be in the same server group for the auto upgrade/downgrade to function properly.
+
2) Custom Field Management (Add new)<br />
 +
- Name: serverlocation<br />
 +
- Type: Pulldown<br />
 +
- Text Display: Datacenter Choice<br />
 +
- Default Value: |9999:No Preference|1:Sarasota DC|2:Tampa DC|3:Dallas DC|4:Seattle DC|<br />
 +
These are your server locations as set in AWBS. <br />You will need your servers in your server groups correctly assigned to locations and Load Balancing turned on.<br />
 +
The format is: |location id number from AWBS:Name shown to customer|<br /><br />
  
−
Package Name: Name the plan as you desire. Do not use any spaces.
+
- Response Required<br />
 +
- Visible When Ordering<br />
  
−
Package Type: Select the correct package type for this plan.
+
3) Assign the new custom field to packages as needed.
  
−
Server Package: Enter the package name as it appears in WHM.
+
Create as many custom fields with the same configuration but with the options set as needed as assign to hosting packages.
−
 
+
−
Package Desc: Enter the plan description as you wish it to appear on the web page for ordering.
+
−
 
+
−
Reset BW on all existing user hosting: Check if you want to reset all bandwidth stats stored in AWBS database for all existing active accounts on this plan.
+
−
 
+
−
Reseller Plan: Check if this is a reseller plan.
+
−
 
+
−
Pricing: Enter prices for all terms you want to offer. Leave the fields blank if you don't want to offer them. Enter 0.00 if you want to offer them for free.
+
−
 
+
−
Check the Free Domain checkbox if you want to offer a free domain name with this plan/term.
+
−
 
+
−
(Select available tlds for free domains in the system setup, TLD Setup/Pricing page by checking the Free Option checkbox beside the tld)
+
−
 
+
−
Assign the correct Activation Email Template. Be sure to either add a new email template or edit the existing Hosting Activation email template as desired to give your customers all necessary information they need when their account is activated.
+
−
 
+
−
Complete the Package Display Text section with the plan's specs.
+
−
 
+
−
==Helm ==
+
−
 
+
−
== Interworx ==
+
−
 
+
−
== Plesk ==
+
−
 
+
−
== TCAdmin ==
+
−
 
+
−
== Teamspeak ==
+
−
 
+
−
== VirtualMin Information ==
+
−
 
+
−
== Zervex ==
+
−
 
+
−
==Sub Domain Hosting ==
+

Latest revision as of 08:48, May 27, 2020

Table of Contents

  1. Hosting Configuration - Read First!
  2. Cast Control Module
  3. CentovaCast Module
  4. CloudMin Module
  5. cPanel Module
  6. cPanel with WHMSonic Module
  7. DirectAdmin Module
  8. DotNetPanel Module
  9. eNom Hosting Module
  10. Ensim Module
  11. GameCP Module
  12. Helm Module
  13. Hostopia Module
  14. HyperVM Module
  15. Interworx Module
  16. ISP Manager Module
  17. LxAdmin/Kloxo Module
  18. Plesk Module
  19. SolusVM Module
  20. TCAdmin Module
  21. Teamspeak Module
  22. Teamspeak 3 Module
  23. VDS Manager Module
  24. VirtualMin Module
  25. VPS.net Module
  26. WHMPHP Module
  27. Zervex Module
  28. Alternate Order Wizard
  29. Sub Domain Hosting
  30. Load Balancing

Hosting Configuration - Read First!

In the AWBS Configuration, Module Setup page, make sure you have enabled all hosting control panels that you will use/configure.

In the AWBS Configuration, System Options page, set all preferences as desired for your company.

>>Do the following in order to setup the structure for your hosting configuration properly.<<

  1. Setup server groups. (Screenshot)
    Use the server groups to form load balancing groups and/or categories. Example: put all cpanel servers in group1 and all helm servers in group2.
    Note: You must have at least one server group.
  2. Setup your server(s). Add all hosting servers you will be setting up client hosting on. Select the correct server group. Refer to the specific control panel configuration pages for detailed help for your server type.
  3. Go back to server groups and select a default server for each group and save. Save the record even if the correct group shows up.
  4. Setup hosting package types. These types will categorize your hosting plans in groups to be displayed together on a web page for ordering. Create a hosting package type for each web display page you want on your site.
    Hint: Once you have setup a type, you can click to edit and you will find a link to use on your menu for that type's display page.
  5. Setup your hosting plans in the hosting plan setup page. Refer to the hosting control panel specific configuration pages for detailed help for setting up your plans correctly.

TEST

  • Place a test order for hosting using your test user account (create an account for testing if you did not already).
  • Log back in as admin, go to the job queue. Your new order should be in the open job queue if you have 'Process all hosting orders immediately' set to True in the System Options area. The new order will show up in the pending queue if you have 'Process all hosting orders immediately' set to False in the System Options.
  • Click the run link to the left of the new order in the job queue to manually process the order. A popup window will open and display the progress of the communication to the hosting server. If all is configured properly, the hosting account will be created on the hosting server and the user account will receive an email notifying them their hosting account is active and give them login details as per the email template you have assigned to the hosting plan in the hosting plan configuration page.

If there are any errors, you can click to edit the job and check the 'return' field for any errors reported by the hosting server's API. To get more information for troubleshooting, you can place the job queue in debug mode by clicking the debug mode link at the top of the job queue, then run the job again. Details of the communication will appear in the popup window when the job runs in debug mode. It is recommended to leave debug mode set to off unless you need to troubleshoot a problem/error.

Alternate Order Wizard

(Note: Alternate Order Wizard feature available version 2.8.0 and newer)

The alternate order wizard can be enabled for either hosting or dedicated server ordering (not both).

The alternate order wizard uses the AWBS API, to use it you'll need to add your server's main IP to the Extended System Configuration, remote_list setting.
(If you see 'Domain not available' for all domain searches, you have not configured the API for access)

Enable the alternate order wizard on a per package basis by editing each hosting package you want to use the alternate order wizard and set the Use Alternate Order Wizard setting to True and save.

Enable the alternate order wizard on a per type basis by editing the hosting package type and set Use Alternate Order Wizard to True and save.

Menu links are available both in the hosting package type setup page and hosting package setup pages to use on your website or menu as desired.


There are 3 settings in the order.php engine file.

$carton = "0"; // 0 - send customers right to the payment page (skip the cart), 1 - send orders to the cart
$apiurl = ""; //(no trailing slash) if blank will use this url (complete if using a different url than your AWBS site)
$emptycart = "1"; //Empty the cart prior to adding the new package? This will remove all items from the cart


Note: The order.php engine file, template and includes are all open source, edit as desired!

Sub Domain Hosting

Configuration >> Sub-Domain Hosting Setup >> [Add Record]

Setup any domains you want sub domain hosting ordered for.

For any hosting packages you want to offer the sub-domain hosting for: Configuration >> Hosting Package Setup >> select desired package(s)

Check the checkbox that says: Sub-Domain Ordering ALLOWED

Load Balancing

Load balancing is used to have hosting accounts provisioned equally among a group of servers.

To activate load balancing for any server group, check the box that says: Activate Load Balancing in the Configuration >> Server Groups >> [desired server group] setup page.

AWBS will take new orders and check for the server in that group with the least number of accounts on it and provision to that server.

Notes: Control panel types that support over bandwidth billing will pull the account numbers from the server stats data pulled from the servers. Control panel types that do not support the server stats data gathering will pull the account numbers from AWBS's hosting manager.

Alternate use of the Load Balancing system

This will provision accounts based on user selection of server location (datacenter).


1) Assign all servers to the proper server location (Create locations as needed and note the ID for use below) Configuration >> Server Locations

2) Custom Field Management (Add new)
- Name: serverlocation
- Type: Pulldown
- Text Display: Datacenter Choice
- Default Value: |9999:No Preference|1:Sarasota DC|2:Tampa DC|3:Dallas DC|4:Seattle DC|
These are your server locations as set in AWBS.
You will need your servers in your server groups correctly assigned to locations and Load Balancing turned on.
The format is: |location id number from AWBS:Name shown to customer|

- Response Required
- Visible When Ordering

3) Assign the new custom field to packages as needed.

Create as many custom fields with the same configuration but with the options set as needed as assign to hosting packages.

Retrieved from "https://www.awbswiki.com/index.php?title=Hosting_Modules&oldid=2032"