View source for AppSuite:Connector for WHMCS Installation Guide

= Under Development: Connector for WHMCS =

== Description ==

Integration of OX App Suite with WHMCS/cPanel makes the deployment of OX App Suite simple for service providers and their customers. 
Web hosters can easily replace their existing webmail system on WHMCS/cPanel and provide customers a state-of-the-art, web based user interface with the benefits of a best in class, full-featured mobile web application – optimized for smartphones!
The combination of OX App Suite, the provisioning of cPanel and the billing system WHMCS provides the perfect package for cPanel Hosting Provider and Reseller 

== Requirements ==

The Connector for WHMCS can be installed in any Linux platform that supports WHMCS. Version needs to be 5.2.5 or newer. 

For  WHMCS installation and licensing, please refer to:
http://docs.whmcs.com/Installing_WHMCS
http://docs.whmcs.com/Licensing 

At least one cPanel server with OX plugin for cPanel, is needed for integration as well.

For information on how to install the OX cPanel plugin, please refer to:
http://oxpedia.org/wiki/index.php?title=Open-Xchange_cPanel_Installation

== Mode of Operation ==

To be able to use the Connector for WHMCS, you will need at least one host with cPanel installed and properly configured to work with OX App Suite and Open-Xchange Hosting Edition and an additional server with WHMCS release 5.2.5 or newer.

The Connector for WHMCS enables hosting companies and their resellers to add OX packages to their product offerings as well as billing and support. The following architectural diagram shows how the Connector for WHMCS interacts with other components:

[[image:whmcs_environment.png|600px]]

= Installation =

Obtain the zip file from the link above and save it to a temporary location.

Open an Xwindows terminal login as the root user and find the WHMCS base directory within the apache document root (for Debian it is /var/www/whmcs, for CentOS and RHEL it is /var/www/html/wmcs/).
 # cd /var/www/html/whmcs
or
 # cd /var/www/whmcs

Go to the modules/addons subdirectory of the WHMCS base directory and create a directory called “openxchange.”
 # cd modules/adons
 # mkdir openxchange

Unzip the contents of the OX WHMCS add-on module zip file.
 # cd openxchange

 unzip -a /var/tmp/Open-Xchange_WHMCS_Install.zip

 Archive:  ../Open-Xchange_WHMCS_Install.zip
 extracting: config.ini              [text]  
  inflating: hooks.php               [text]  
  inflating: openxchange.php         [text]  
   creating: controllers/
  inflating: controllers/ox_controller.php  [text]  
   creating: lang/
  inflating: lang/english.php        [text]  
   creating: library/
  inflating: library/ox.php          [text]  
   creating: models/
  inflating: models/ox_model.php     [text]  
   creating: views/
  inflating: views/list_addon.php    [text]  
  inflating: views/manage_ox_packages.php  [text]  
  inflating: views/oxprofile.php     [text]  
  inflating: views/search.php        [text]

{| 
| [[image:whmcs_login.png|400px]] || style="width:85%"| 
Now login to the WMCS console via http://your.server.name/whmcs/admin
|-
| [[image:whmcs_addon_modules.png|400px]] || style="width:85%"| 
Once you login, go to Setup -> “Addon Modules”
|-
| [[image:whmcs_addon_activation.png|500px]] || style="width:85%"| 
After getting to the Connector for WHMCS within the list of modules, proceed to activate and configure the Connector by providing the OX App Suite URL and login credentials.
|}

= Configuration - First steps =

== Launching WHMCS ==

{| 
| [[image:whmcs_login.png|400px]] || style="width:85%"| 
Login to the WMCS console via http://your.server.name/whmcs/admin
|}

== Setting Up cPanel server ==

{| 
| [[image:cpanel_screen_002.png|400px]] || style="width:85%"| 
Once within WHMCS, go to Setup -> Product/Services -> Servers -> Add new Server.
|-
| [[image:cpanel_screen_003.png|400px]] || style="width:85%"| 
Enter the different attributes for the new cPanel host instance, make sure to scroll down and choose type cPanel and the right credentials to access the host
|}

== Setting Up WHMCS plans ==

In order for WHMCS to integrate properly with cPanel, one needs to create the plans and packages to match cPanel. Each package which exist in cPanel must also exist in WHMCS.

{| 
| [[image:cpanel_screen_005.png|400px]] || style="width:85%"| 
Go to Setup ⇒ Products/Services -> Products/Services -> Create a New Product
|-
| [[image:cpanel_screen_006.png|400px]] || style="width:85%"| 
Click on continue and proceed to enter relevant information
|-
| [[image:cpanel_screen_007.png|400px]] || style="width:85%"| 
Go to the Module Settings tab and enter „Module Name“ and „WHM Package Name,“ this is the name that must match with cPanel.
|}

== Importing cPanel accounts ==

{| 
| [[image:cpanel_screen_008.png|400px]] || style="width:85%"| 
Once WHMCS plans have been created to match cPanel packages, you may import cPanel accounts from Utilities ⇒ cPanel/WHM import
|-
| [[image:cpanel_screen_009.png|400px]] || style="width:85%"| 
After choosing the right cPanel host and clicking on „Get Account List“ you will be see all the cPanel accounts which exist on the cPanel server
|}

== Creating cPanel Clients ==

{| 
| [[image:cpanel_screen_011.png|400px]] || style="width:85%"| 
Go to Clients -> Add New Clients
|-
| [[image:cpanel_screen_012.png|400px]] || style="width:85%"| 
Go to the „Products/Services“ tab and choose the plan for the new client
|-
| [[image:cpanel_screen_013.png|400px]] || style="width:85%"| 
Click on „Submit Order“
|-
| [[image:cpanel_screen_014.png|400px]] || style="width:85%"| 
Make sure to choose the right cPanel server and check „Run Module Create“ and click „Accept Order“. You may login to cPanel to verify that the account has been created in cPanel.
|-
| [[image:cpanel_screen_015.png|400px]] || style="width:85%"| 
You may also check the OX environment to make sure the OX context has been created.
|}