AppSuite:Connector for WHMCS Installation Guide

Revision as of 08:53, 21 August 2013 by Khgras (talk | contribs)

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:

Install on OX App Suite

Debian GNU/Linux 10.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb https://LDBACCOUNT:LDBPASSWD@software.open-xchange.com/products/appsuite/stable/whmcs/DebianBuster/ /

and run

$ apt-get update
$ apt-get install open-xchange-whmcs

Debian GNU/Linux 11.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb https://LDBACCOUNT:LDBPASSWD@software.open-xchange.com/products/appsuite/stable/whmcs/DebianBullseye/ /

and run

$ apt-get update
$ apt-get install open-xchange-whmcs


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]  

Now login to the WMCS console via http://your.server.name/whmcs/admin