Howto: WHMCS Plugin for SCInterface

From SCInterface Wiki

Jump to: navigation, search

The following documentation is to provide assistance with configuring the WHMCS module for SCInterface. Support for WHMCS is provided by WHMCS.

Contents

[edit] Terminology

Here are the meanings of some terms (sorted in alphabetical order) mentioned in this document where the definition may be otherwise unknown or awhmcsiguous.

  • DS / Dedicated Server : see Host. This term is often used by Datacenters and Server Providers that will resell access to a host while managing the external requirements (space, electricity, ip network connectivity) and sometimes (but not always) the host operating system.
  • Game type : Type of application server, such as 'Counter-Strike Source' or 'Battlefield 2'. Also see SConnector
  • Host: Physical or Virtual PC with an installed operating system. This is typically a container for applications or game servers.
  • GS/Game Server : application running on a host, instance of a game type. Something like "Bill's BF2 Server"
  • GSP / Game Serv(ice|er) Provider : Resellers of Game Servers (and sometimes Dedicated Servers)
  • WHMCS / WHM:CS : The billing system into which you're trying to integrate your SCInterface Network : http://www.whmcs.com
  • Network : Usually SCInterface Network, but depending on context could also mean your host and its Network-Layer peers (as defined by the OSI)
  • Panel : Same as WHMCS's definition : Instance of the SCInterface module in WHMCS's Server Groups. This relates to 1 SCInterface user on a given SCInterface Network (and address/port of the SCM to get into that SCInterface Network)
  • SCInterface : The game server control product in it's entirety, including the UI, the SCManager and SController components (but not necessarily the actual deployment) http://www.scinterface.com
  • SC / SController / SCInterface Controller : Software agent that sits on the targeted host to enable SCInterface to control it.
  • SCM / SCManager / SCInterface Control Manager : Entrypoint for a UI into a SCInterface Network. Software agent that manages everything in your SCInterface Network. This is sometimes synonymous with SCInterface Network as you typically have one SCManager per SCInterface Network, but there may be multiple SCMs in the same network.
  • SCInterface Network : what you see if you login to a SCInterface UI as system admin : The list of Users, SCMs, SCs, Game Servers as they are configured.
  • SConnector / Driver : Configurations in SCInterface that define how SCInterface interacts with a game server or SController of a given type. (see Game Type)
  • SCUser / SCInterface User : your user in a SCInterface Network. Can also mean the username used to login as that user on that network.
  • Server : see GS / GameServer
  • UI : SCInterface User Interface. An interface for your users to interact with a SCInterface Network. This plugin enables WHMCS to act as a UI to interact with your SCInterface Network.

[edit] Documentation

[edit] Prerequisites

The following prerequisites must be met before downloading and installing the SCInterface module for WHMCS.

  1. Purchase, download and install SCInterface v2.0 or later.
  2. Purchase, download and install WHMCS v3.2 or later.
  3. This plugin currently supports the provisioning of applications within SCInterface.
  4. Next, download and install the SCInterface module for WHMCS.

[edit] Install WHMCS's SCInterface Module

As of WHMCS v3.2, SCInterface is included with the latest distribution. Please skip to the next section to continue with the configuration of WHMCS with SCInterface.

  1. Download the latest version of WHMCS from http://www.whmcs.com. The SCInterface plugin is included in the latest WHMCS release. If you do not have this plugin available within your WHMCS installation, please contact WHMCS at http://www.whmcs.com to obtain the latest version.
  2. Enable the plugin within WHMCS. SCInterface v2.0 or later supports WHMCS.

[edit] For Developers Only - Using downloaded tar archive

The following is for developers and testing only. Regular users should download the latest release of WHMCS from http://www.whmcs.com. Contact SCInterface to download a developer version of the WHMCS module at http://www.scinterface.com.

  • Using Subversion
    1. Navigate to your whmcs installation folder : cd /var/www/whmcs
    2. Checkout the SCInterface module and api : svn co svn://svn.scinterface.com/whmcs_plugin/trunk .
  • Using downloaded tar archive
    1. Navigate to your installation folder : cd /var/www/whmcs
    2. Extract archive : tar -xzvf scinterface_whmcs_plugin.tar.gz

[edit] Configure Servers

The following steps guide you through the process of setting up a server in WHMCS for SCInterface.

  1. Begin by going to Configuration > Manage Servers
  2. Click Add New Server
  3. Enter the server name, IP address, select the server type "scinterface" from the dropdown menu, and enter the username and password for SCInterface administrator (i.e. sysadmin). We recommend creating a separate user within SCInterface with access only to the SCs that you want WHMCS to provision applications on it.
  4. Click Create Server to complete the process and add your new cPanel Server

[edit] Create Products

Creating Products with WHMCS - Follow the steps in there, they will guide you to create your products.

After adding your products, go under 'Module Settings' of your product and select Scinterface as Module Name and select your SCInterface server you previous added from the drop down at the Default Install Server. Next you must tell WHMCS witch Application is this product at SCInterface this is done by Filling the Driver ID. You can find DriverID from SCInterface at the Admin->Drivers section, Driver id is the parameter serverID at the url when viewing a Driver.

[edit] Frequently Asked Questions / FAQ

  1. How can I reuse the same SCInterface user for multiple products/packages ?
    • The SCInterface plugin will try to use whatever information it gets from the order, so ultimately this is managed by WHMCS. In case of conflict (the proposed username already exist, but doesn't appear to be a customer of the current panel, SCInterface will automatically try adding digits until it is able to create the new user.
    • WARNING: If the service username provided matches someone else's username under the same panel/server, then that user will be reused, and thus gain access to your product. It is your duty as a whmcs administrator to make sure this doesn't happen. A quick way would be to use the client's whmcs username as a prefix for the service username on SCInterface.


[edit] Troubleshooting

none yet

Retrieved from "http://wiki.scinterface.com/index.php/Howto:_WHMCS_Plugin_for_SCInterface"
Personal tools