WHMCS Documentation - User contributions [en]

Server Modules

2010-09-21T12:15:42Z

Joe: /* Hosting Control Panels */

The following provisioning modules are supported.

==Hosting Control Panels==
*[[cPanel/WHM]]
*[[DirectAdmin]]
*[[Plesk]]
*[[Helm 3]]
*[[Helm 4]]
*[[Ensim]]
*[[InterWorx]]
*[[DotNetPanel]] / Websitepanel
*[[Lxadmin]]
*[[Virtualmin Pro]]
*[[XPanel]]

==VPS==
*[[HyperVM]]
*[[FluidVM]]
*[[SolusVM]]
*[[Cloudmin]]
*[[VPS.Net]]

==Shoutcast Panels==
*[[WHMSonic]]
*[[CentovaCast]]
*[[SCPanel]]
*[[CastControl]]

==Gaming Panels==
*[[GameCP]]
*[[TCAdmin]]

==SSL Certificates==
*[[Enom SSL Certificates]]
*[[GlobalSign SSL|GlobalSign SSL Certificates]]

==Other==
*[[Heart Internet]]
*[[Reseller Central]]
*[[Auto Release]]

Server Modules

2010-09-21T12:15:18Z

Joe: /* Hosting Control Panels */

The following provisioning modules are supported.

==Hosting Control Panels==
*[[cPanel/WHM]]
*[[DirectAdmin]]
*[[Plesk]]
*[[Helm 3]]
*[[Helm 4]]
*[[Ensim]]
*[[InterWorx]]
*[[DotNetPanel]] / websitepanel
*[[Lxadmin]]
*[[Virtualmin Pro]]
*[[XPanel]]

==VPS==
*[[HyperVM]]
*[[FluidVM]]
*[[SolusVM]]
*[[Cloudmin]]
*[[VPS.Net]]

==Shoutcast Panels==
*[[WHMSonic]]
*[[CentovaCast]]
*[[SCPanel]]
*[[CastControl]]

==Gaming Panels==
*[[GameCP]]
*[[TCAdmin]]

==SSL Certificates==
*[[Enom SSL Certificates]]
*[[GlobalSign SSL|GlobalSign SSL Certificates]]

==Other==
*[[Heart Internet]]
*[[Reseller Central]]
*[[Auto Release]]

Server Modules

2010-09-21T12:14:39Z

Joe: /* Hosting Control Panels */

The following provisioning modules are supported.

==Hosting Control Panels==
*[[cPanel/WHM]]
*[[DirectAdmin]]
*[[Plesk]]
*[[Helm 3]]
*[[Helm 4]]
*[[Ensim]]
*[[InterWorx]]
*[[DotNetPanel]] / [[websitepanel]]
*[[Lxadmin]]
*[[Virtualmin Pro]]
*[[XPanel]]

==VPS==
*[[HyperVM]]
*[[FluidVM]]
*[[SolusVM]]
*[[Cloudmin]]
*[[VPS.Net]]

==Shoutcast Panels==
*[[WHMSonic]]
*[[CentovaCast]]
*[[SCPanel]]
*[[CastControl]]

==Gaming Panels==
*[[GameCP]]
*[[TCAdmin]]

==SSL Certificates==
*[[Enom SSL Certificates]]
*[[GlobalSign SSL|GlobalSign SSL Certificates]]

==Other==
*[[Heart Internet]]
*[[Reseller Central]]
*[[Auto Release]]

Server Modules

2010-09-21T12:14:13Z

Joe: /* Hosting Control Panels */

The following provisioning modules are supported.

==Hosting Control Panels==
*[[cPanel/WHM]]
*[[DirectAdmin]]
*[[Plesk]]
*[[Helm 3]]
*[[Helm 4]]
*[[Ensim]]
*[[InterWorx]]
*[[DotNetPanel]]*[[websitepanel]]
*[[Lxadmin]]
*[[Virtualmin Pro]]
*[[XPanel]]

==VPS==
*[[HyperVM]]
*[[FluidVM]]
*[[SolusVM]]
*[[Cloudmin]]
*[[VPS.Net]]

==Shoutcast Panels==
*[[WHMSonic]]
*[[CentovaCast]]
*[[SCPanel]]
*[[CastControl]]

==Gaming Panels==
*[[GameCP]]
*[[TCAdmin]]

==SSL Certificates==
*[[Enom SSL Certificates]]
*[[GlobalSign SSL|GlobalSign SSL Certificates]]

==Other==
*[[Heart Internet]]
*[[Reseller Central]]
*[[Auto Release]]

Security Questions

2010-08-28T21:10:39Z

Joe:

Security questions can be used as an extra level of security when your clients contact you in order to verify their identify. You can then prompt them for the answer to the question they selected.

Also, when resetting their password from the client area, the client will be prompted to select their security question, and enter the answer before a new password will be generated.

You will need to add your security questions before your clients can use this feature. To do that, go to Setup > Security Questions. From here, you can see your existing security questions and how many clients are using them, add new questions, and delete any unused questions.

To add a new question, type in the available text box and press save changes. This will add the security question to the system.

Clients are prompted to choose and answer a security question when registering, modifying their account password or requesting a new password.

You cannot delete Security Questions that are in use.

==Example Questions==

Below are some suggestions for security questions you could use:

*What was the house number and street name you lived in as a child?
*What were the last four digits of your childhood telephone number?
*What primary school did you attend?
*In what town or city was your first full time job?
*In what town or city did you meet your spouse/partner?
*What is the middle name of your oldest child?
*What are the last five digits of your driver's licence number?
*What is your grandmother's (on your mother's side) maiden name?
*What is your spouse or partner's mother's maiden name?
*In what town or city did your mother and father meet?
*What time of the day were you born? (hh:mm)
*What time of the day was your first child born? (hh:mm)

AWHMCS Android App

2010-08-24T01:01:09Z

Joe: /* Setup Instructions */

aWHMCS is the Official Android App for WHMCS.

The price of aWHMCS is a $34.95 one-off charge which allows as many instances of aWHMCS to be used by as many different staff on as many different phones as you wish (the same licensing scheme as with all our mobile editions).

Please visit http://www.whmcs.com/androidapp.php for more information.

==Setup Instructions==

1. To begin with (if you haven't already done so), you will need to order the Android App addon from our client area. It's available as an addon to a license and can be ordered by logging into our client area @ [http://www.whmcs.com/members/clientarea.php www.whmcs.com/members/clientarea.php] and selecting "View Available Addons" from the navigation bar.

2. Once you've ordered and paid, the addon will be instantly activated and you'll just need to perform a local key update by going to '''Help > Check for Updates''' inside your WHMCS installation to have it take effect.

3. Now, you're ready to download the aWHMCS App - you can download this directly from us @ http://www.whmcs.com/members/dl.php?type=d&id=55 or from the Android App Store by searching for "aWHMCS Official WHMCS App" - http://www.androidpit.com/en/android/market/apps/app/com.whmcs.awhmcs/aWHMCS-Official-WHMCS-App

4. Now locate and open the app on your Android device

5. The first time you start the app, you'll be taken straight to the configuration screen for you to input your WHMCS connection details. These consist of your WHMCS URL, admin username & password and an access key.

6. The domain should be the URL to your main site url , for example if installed @ "http://demo.whmcs.com/" then the Domain setting would be "demo.whmcs.com" and the Path would be the directory for the client area so if installed in the root directory, the path would be "/" and the admin username & password the same as you use to login to the main admin area.

If installed @ "http://yourdomain.com/whmcs/" then the domain setting would be "yourdomain.com" and the Path setting would be the directory for the client area "/whmcs/" and the admin username & password the same as you use to login to the main admin area.

7. The access key is slightly more complicated. For this, you need to open up the configuration.php file for your WHMCS installation and add a line to it such as the one below:

$api_access_key = "abc123";

The '''abc123''' in the above should be replaced with a random series of letters and numbers, you can think of it like a second password, and that same value is what you'll need to enter into the Access Key field on your phone

8. Then simply click Save and the connection will be tested. If any of the details were entered incorrectly you'll receive an Access Denied (username/password failure) or Invalid Access Key error message and be returned to re-enter the details.

9. If all was correct, you'll be taken to the home screen and can begin using the app.

AWHMCS Android App

2010-08-24T00:47:23Z

Joe: /* Setup Instructions */

aWHMCS is the Official Android App for WHMCS.

The price of aWHMCS is a $34.95 one-off charge which allows as many instances of aWHMCS to be used by as many different staff on as many different phones as you wish (the same licensing scheme as with all our mobile editions).

Please visit http://www.whmcs.com/androidapp.php for more information.

==Setup Instructions==

1. To begin with (if you haven't already done so), you will need to order the Android App addon from our client area. It's available as an addon to a license and can be ordered by logging into our client area @ [http://www.whmcs.com/members/clientarea.php www.whmcs.com/members/clientarea.php] and selecting "View Available Addons" from the navigation bar.

2. Once you've ordered and paid, the addon will be instantly activated and you'll just need to perform a local key update by going to '''Help > Check for Updates''' inside your WHMCS installation to have it take effect.

3. Now, you're ready to download the aWHMCS App - you can download this directly from us @ http://www.whmcs.com/members/dl.php?type=d&id=55 or from the Android App Store by searching for "aWHMCS Official WHMCS App" - http://www.androidpit.com/en/android/market/apps/app/com.whmcs.awhmcs/aWHMCS-Official-WHMCS-App

4. Now locate and open the app on your Android device

5. The first time you start the app, you'll be taken straight to the configuration screen for you to input your WHMCS connection details. These consist of your WHMCS URL, admin username & password and an access key.

6. The domain should be the URL to your main site url , for example Domain "http://demo.whmcs.com/" Then the PATH would be the directory for the client area so if in the root "/" or "http://www.yourdomain.com/whmcs/" The domain would be http://www.yourdomain.com/ Then the PATH would be the directory for the client area "/whmcs/" and the admin username & password the same as you use to login to the main admin area.

7. The access key is slightly more complicated. For this, you need to open up the configuration.php file for your WHMCS installation and add a line to it such as the one below:

$api_access_key = "abc123";

The '''abc123''' in the above should be replaced with a random series of letters and numbers, you can think of it like a second password, and that same value is what you'll need to enter into the Access Key field on your phone

8. Then simply click Save and the connection will be tested. If any of the details were entered incorrectly you'll receive an Access Denied (username/password failure) or Invalid Access Key error message and be returned to re-enter the details.

9. If all was correct, you'll be taken to the home screen and can begin using the app.

IWHMCS iPhone App

2010-01-06T21:42:19Z

Joe: /* Setup Instructions */

iWHMCS is the Official iPhone Addon for WHMCS.

Please see http://www.whmcs.com/iphoneapp.php for details.

==Setup Instructions==

1. To begin with (if you haven't already done so), you will need to order the iPhone addon from our client area. It's available as an addon to a license and can be ordered by logging into our client area @ [http://www.whmcs.com/members/clientarea.php www.whmcs.com/members/clientarea.php] and selecting "View Available Addons" from the navigation bar.

2. Once you've ordered and paid, the addon will be instantly activated and you'll just need to perform a local key update by going to '''Help > Check for Updates''' inside your WHMCS installation to have it take effect.

3. Now, you're ready to download the iWHMCS app from the Apple iTunes App Store which you can do by simply searching for iWHMCS in iTunes or using this link to take you directly there: http://itunes.apple.com/gb/app/iwhmcs/id343647658?mt=8

4. Once downloaded, simply sync your phone to install the app as normal

5. Now locate and open the app on your iphone's home screen

6. The first time you start it, you'll be asked to enter your authentication details. These consist of your WHMCS URL, admin username & password and an access key.

7. The WHMCS URL should be the URL to the frontend (client area), for example "http://demo.whmcs.com/" or "http://www.yourdomain.com/whmcs/" and the admin username & password the same as you use to login to the main admin area.

8. The access key is slightly more complicated. For this, you need to open up the configuration.php file for your WHMCS installation and add a line to it such as the one below:

$api_access_key = "abc123";

The '''abc123''' in the above should be replaced with a random series of letters and numbers created by you, and that same value is what you'll need to enter into the Access Key field of the iWHMCS configuration screen.

9. Then simply click Save and the connection will be tested. If any of the details were entered incorrectly you'll receive an Access Denied (username/password failure) or Invalid Access Key error message and be returned to re-enter the details.

10. If all was correct, you'll be taken straight to the homepage overview.

ResellerClub

2009-12-27T20:34:20Z

Joe: /* Invalid Password/Username, or your User account maybe Inactive or Suspended */

==AKA DirectI==

{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| getepp = yes
| regns = yes
}}

If you don't already have an account with ResellerClub/DirectI, you can signup for the free account we offer to all clients [http://www.whmcs.com/resellerclubdomains.php here]!

==DirectI vs ResellerClub==

WHMCS has two domain registrar modules; DirectI and ResellerClub. You can use either with a ResellerClub/DirectI account, the different modules determine the way domains are registered and how your customers manage them.

The DirectI module requires that you create a customer under your reseller account, all domain orders will be placed by this customer. Your customers can only manage their domain names through WHMCS.

The ResellerClub module will create a customer account under your reseller account for each of your customers. They will be able to login to the SuperSite interface and manage their domain names (this offers more options than WHMCS alone). Your customers can still use WHMCS to manage their domain names.

If you want your customers to be given a login to the SuperSite interface then you should choose the ResellerClub module, if you do not, choose DirectI.

==Configuration in WHMCS==

#Login to your domain reseller account as instructed in the email you received when you signed up and go to Settings > Personal Information > Primary Profile - the value you need to note is the Parent ID
#Next, login to your WHMCS Administration Area
#Go to Configuration > Domain Registrars
#Choose "Resellerclub" in the registrar dropdown menu and enter the email address and password you set when you signed up aswell as the Parent ID noted from the first step
#Then click Save Changes

And that's it, WHMCS will now be able to communication with your DirectI/ResellerClub account to automate domain registration & management for your customers.

==Demo Mode==

To use the ResellerClub demo mode, it's not as simple as ticking the demo mode option in the configuration area. You must setup an account seperately on the dedicated demo system they offer @ http://cp.onlyfordemo.net/reseller

==Expiry Date Syncronisation==

As of V3.6, you can now have WHMCS sync the expiry dates of domains you have registered with DirectI. This is particularly useful for domain transfers where the expiry date cannot be calculated automatically. We recommend running the sync once per week. To do that, you need to setup a cron job to run the file modules/registrars/resellerclub/resellerclubsync.php using a command such as the one below.

php -q /home/username/public_html/modules/registrars/resellerclub/resellerclubsync.php

==Common Problems==

===Connection Problems===

*HTTP Error: Couldn't open socket connection to server: http://www.myorderbox.com/anacreon/servlet/APIv3
*Domain Registration Error - Unable to connect to Registry

These errors occur when the ResellerClub server is unreachable. They may be experiencing problems or it could be a local firewall blocking the connection.

===Invalid Password/Username, or your User account maybe Inactive or Suspended ===
This error response means the login details you have entered in Setup > Domain Registrars for the Resellerclub module are incorrect or your account is suspended. A suspended account is unlikely so make sure to check your configuration details first.

===Telephone No. is invalid. Please note that only digits are allowed===
You should only enter the phone number as it would be called from that country. No country codes should be entered.

===Further Help===
For further help with ResellerClub accounts and management, refer to their knowledgebase @ http://freeaccount.myorderbox.com/kb/

{{modules}}

Email Templates

2009-12-27T16:40:56Z

Joe:

The email templates allow you to customise the messages that go out to your customers when actions occur inside WHMCS. Every email that goes out to a customer can be customised here.

To edit an email template, go to Setup > Email Templates and click the edit icon next to the template you want to change.

You can also toggle plain text vs. HTML email sending on a per email basis from the editor page.

A list of the data fields available to you when composing an email are shown below the editor. The merge fields you can use depend upon what the email is related to and so you can't always use the fields from one template in another - only those of the same group.

Ensim

2009-12-14T19:55:41Z

Joe: /* '''Step 2: Symbolic Links''' */

== '''Important Notes''' ==

1. This only currently works for ensim servers local to the WHMCS install. A script specifically for remote ensim servers is being developed.

2. Access to the Sudo command is required from PHP for this to work.

3. By default Ensim has a command in the /etc/sudoers file "Defaults requiretty" you will need to commend this out by changing it to "#Defaults requiretty" in order to allow Sudo access to PHP

== '''Overview''' ==

1) [[Ensim#Step_1:_Setup_the_WHMCS_Local_Server|Setup the WHMCS Local Server]]

2) [[Ensim#Step_2:_Symbolic_Links|Setup Symbolic Links on your server]]

3) [[Ensim#Step_3:_Setup_the_Products_with_Ensim_Packages|Setup the Products with Ensim Packages]]

=== '''Step 1: Setup the WHMCS Local Server''' ===

* 1. Goto Configuration -> Add New Server

* 2. Click Add New Server

* 3. Configure your server settings, choose the server type "EnsimX"

* 4. Enter a Password for the server, you will need this password later on. A Username Or server hash is not required

* 5. Click Save

=== '''Step 2: Symbolic Links''' ===

Now you will need to create symbolic links to the VirtDomain scripts on the local Ensim server. You will need to be logged in as the root account in order to complete this step. For our example, we would use the following commands to create the needed links:

'''**** REPLACE PASSWORD IN EACH LINE BELOW WITH YOUR SERVER PASSWORD'''

cd /usr/local/bin
ln -s AddVirtDomain AddVirtDomain-PASSWORD
ln -s DeleteVirtDomain DeleteVirtDomain-PASSWORD
ln -s EnableVirtDomain EnableVirtDomain-PASSWORD
ln -s DisableVirtDomain DisableVirtDomain-PASSWORD
ln -s EditVirtDomain EditVirtDomain-PASSWORD
ln -s AddReseller AddReseller-PASSWORD

Copy the file "ChangeDomainPasswd-PASSWORD" from the zip file here https://www.whmcs.com/members/dl.php?type=d&id=29 to /usr/local/bin .. remember to rename the file with your server password entered above instead of PASSWORD
Edit the file /etc/sudoers. Add the following lines to the end of the file, substituting your link names as needed.

<nowiki>==================================================================</nowiki>

Cmnd_Alias ENSIM = /usr/local/bin/AddVirtDomain-PASSWORD, \
/usr/local/bin/DeleteVirtDomain-PASSWORD, \
/usr/local/bin/EnableVirtDomain-PASSWORD, \
/usr/local/bin/DisableVirtDomain-PASSWORD, \
/usr/local/bin/EditVirtDomain-PASSWORD, \
/usr/local/bin/AddReseller-PASSWORD, \
/usr/local/bin/ChangeDomainPasswd-PASSWORD
apache ALL=(ALL) NOPASSWD: ENSIM

<nowiki>==================================================================</nowiki>

Save and close the file.

=== '''Step 3: Setup the Products with Ensim Packages''' ===

* 1. Setup the Hosting Plans in your Ensim Server Administrator Panel By clicking on SITE MANAGER -> Add Service Plan. Write down the name of the service plan - DO NOT PUT SPACES IN THE NAME - If you want to put a space, put an underscore _

* 2. Login to the WHMCS Control Panel

* 3. Go to Configuration -> Products/Services

* 4. Create a product and configure as required

* 5. Then click "Module Settings"

* 6. Choose Applies to Server Type "EnsimX"

* 7. Set "Package Name" to the same name as the Service Plan you setup in step 1

* 8. Save changes, and test by placing a new order and setting the cost of the product to $0

Enjoy!

{{modules}}

Installing WHMCS

2009-10-23T18:20:59Z

Joe: /* Post Installation Suggested Steps */

==Downloading WHMCS==

To download WHMCS, login to our client area at [http://www.whmcs.com/members/clientarea.php www.whmcs.com/members] and then do the following:

#Click the My Products & Services link
#Select one of your active license keys to view the details
#Choose the latest stable version to download from the downloads listed at the bottom of the page

==Installing Ioncube==

WHMCS is encrypted using the Ioncube system. There are therefore two ways to use WHMCS. You can use the runtime decoders or you can install the Ioncube decoders into php directly. The first way is simplest as all you have to do is upload the ioncube folder from the Ioncube download in our client area to your WHMCS directory but it doesn't always work. So the second is slightly more difficult, but more commonly successful, and here is a tutorial on how to do it.

You WILL require root access to the server in order to do this.

#Download the latest loaders to your computer from http://www.ioncube.com/loaders.php
#Extract the contents of the archived file on your local PC to a folder of your choice.
#Upload the folder IONCUBE via FTP to your domain webspace
#Now establish an SSH connection with server using a suitable client (e.g. Putty for PC's or Terminal on Mac). This is usually done using the command: SSH rootusername@yourserver.com (you will then be asked for your password).
#You will need to browse to the public folder where you uploaded the IONCUBE directory (search internet for change and view directory commands in Unix).
#Move the ioncube folder to a permanent location by entering: mv ioncube /usr/local
#Next, you need to locate the php.ini file, to do this enter: locate php.ini - You should find it is in /usr/local/lib/php.ini. Now that you know the location of php.ini you need to edit it. pico /usr/local/lib/php.ini
#Now find where other zend extentions are in the file: ctrl + w: zend_extension
#Paste in your new line for ioncube loader: zend_extension = /usr/local/ioncube/ioncube_loader_lin_x.so (Replace x with your version of PHP eg. 4.4)
#Save the changes: ctrl + X then Y and enter
#Restart the web server to take effect: /etc/init.d/httpd restart

That's it! Ioncube is now installed on your server! You should now see a section in your PHP Info page that says:

Additional Modules
Module Name ionCube Loader

==Installing WHMCS==

Installing WHMCS is very simple. The following steps will guide you through the process:

#Unzip the contents of the zip file to a folder on your computer
#Rename the file configuration.php.new to configuration.php
#Upload the entire whmcs folder to your website - if you experience problems, try uploading in binary mode
#Next you can rename the folder to whatever you like (billing, clients, etc...)
#Now visit the installation script at http://www.yourdomain.com/whmcs/install/install.php to run the installer process - if you get an Ioncube related error message, see the installation Ioncube steps above
#Follow the instructions on screen to install which will involve setting file permissions as listed below, entering your license key and setting up your primary admin account
#When complete, delete the install folder from your web server and CHMOD the configuration.php file back to 644.

Required file & folders permissions (unless your php is suPHP or PHPSuExec):

/configuration.php CHMOD 777 Writeable
/attachments CHMOD 777 Writeable
/downloads CHMOD 777 Writeable
/templates_c CHMOD 777 Writeable

==Post Installation Suggested Steps==

After installation is completed, we recommend that you go through and configure your new WHMCS system in the following order:

#Login to the Admin Area and configure your General Settings (Setup > General Settings)
#Setup your Payment Gateways (Setup > Payment Gateways)
#Setup your Products & Services (Setup > Products/Services)
#Configure your Domain Pricing (Setup > Domain Pricing)
#Setup your Support Ticket Departments (Setup > Support Departments)
#Setup email piping so you can manage tickets using the WHMCS Support Desk - for full instructions on this please see the relevant article
#Ensure the WHMCS Cron Job is setup and configure automated tasks (Setup > Automation Settings)
#Place some test orders on your website to check everything works as expected

For furthur guidance, you can watch video tutorials we have prepared for the above tasks @ [http://www.whmcs.com/tutorials.php www.whmcs.com/tutorials.php]

Installing WHMCS

2009-10-23T18:20:22Z

Joe: /* Post Installation Suggested Steps */

==Downloading WHMCS==

To download WHMCS, login to our client area at [http://www.whmcs.com/members/clientarea.php www.whmcs.com/members] and then do the following:

#Click the My Products & Services link
#Select one of your active license keys to view the details
#Choose the latest stable version to download from the downloads listed at the bottom of the page

==Installing Ioncube==

WHMCS is encrypted using the Ioncube system. There are therefore two ways to use WHMCS. You can use the runtime decoders or you can install the Ioncube decoders into php directly. The first way is simplest as all you have to do is upload the ioncube folder from the Ioncube download in our client area to your WHMCS directory but it doesn't always work. So the second is slightly more difficult, but more commonly successful, and here is a tutorial on how to do it.

You WILL require root access to the server in order to do this.

#Download the latest loaders to your computer from http://www.ioncube.com/loaders.php
#Extract the contents of the archived file on your local PC to a folder of your choice.
#Upload the folder IONCUBE via FTP to your domain webspace
#Now establish an SSH connection with server using a suitable client (e.g. Putty for PC's or Terminal on Mac). This is usually done using the command: SSH rootusername@yourserver.com (you will then be asked for your password).
#You will need to browse to the public folder where you uploaded the IONCUBE directory (search internet for change and view directory commands in Unix).
#Move the ioncube folder to a permanent location by entering: mv ioncube /usr/local
#Next, you need to locate the php.ini file, to do this enter: locate php.ini - You should find it is in /usr/local/lib/php.ini. Now that you know the location of php.ini you need to edit it. pico /usr/local/lib/php.ini
#Now find where other zend extentions are in the file: ctrl + w: zend_extension
#Paste in your new line for ioncube loader: zend_extension = /usr/local/ioncube/ioncube_loader_lin_x.so (Replace x with your version of PHP eg. 4.4)
#Save the changes: ctrl + X then Y and enter
#Restart the web server to take effect: /etc/init.d/httpd restart

That's it! Ioncube is now installed on your server! You should now see a section in your PHP Info page that says:

Additional Modules
Module Name ionCube Loader

==Installing WHMCS==

Installing WHMCS is very simple. The following steps will guide you through the process:

#Unzip the contents of the zip file to a folder on your computer
#Rename the file configuration.php.new to configuration.php
#Upload the entire whmcs folder to your website - if you experience problems, try uploading in binary mode
#Next you can rename the folder to whatever you like (billing, clients, etc...)
#Now visit the installation script at http://www.yourdomain.com/whmcs/install/install.php to run the installer process - if you get an Ioncube related error message, see the installation Ioncube steps above
#Follow the instructions on screen to install which will involve setting file permissions as listed below, entering your license key and setting up your primary admin account
#When complete, delete the install folder from your web server and CHMOD the configuration.php file back to 644.

Required file & folders permissions (unless your php is suPHP or PHPSuExec):

/configuration.php CHMOD 777 Writeable
/attachments CHMOD 777 Writeable
/downloads CHMOD 777 Writeable
/templates_c CHMOD 777 Writeable

==Post Installation Suggested Steps==

After installation is completed, we recommend that you go through and configure your new WHMCS system in the following order:

#Login to the Admin Area and configure your General Settings (Setup > General Settings)
#Setup your Payment Gateways (Setup > Payment Gateways)
#Setup your Products & Services (Setup > Products/Services)
#Configure your Domain Pricing (Setup > Domain Pricing)
#Setup your Support Ticket Departments (Setup > Support Departments)
#Setup email piping so you can manage tickets using the WHMCS Support Desk - for full instructions on this please see the relevant article
#Ensure the WHMCS Cron Job is setup and configure automated tasks (Configuration > Automation Settings)
#Place some test orders on your website to check everything works as expected

For furthur guidance, you can watch video tutorials we have prepared for the above tasks @ [http://www.whmcs.com/tutorials.php www.whmcs.com/tutorials.php]

Further Security Steps

2009-09-20T13:40:54Z

Joe: /* Move the attachments, downloads & templates_c folders */

The guide below describes various extra steps you can take to further secure your WHMCS system.

==Move the attachments, downloads & templates_c folders==

The three folders "attachments", "downloads" and "templates_c" need to be writeable by WHMCS and therefore require the permissions 777 (writable by all). When folders have this permission level it is safer to place the folders outside of the public accessible folder tree on your website. WHMCS allows you to do this. If you do move the folders, then you must tell WHMCS where they have been moved to by adding the following lines to your configuration.php file:

$templates_compiledir = "usr/home/username/public_html/whmcs/templates_c/";
$attachments_dir = "usr/home/username/public_html/whmcs/attachments/";
$downloads_dir = "usr/home/username/public_html/whmcs/downloads/";

Note that if you are running suphp or phpsuexec you should not make the mode changes as the folders will already be writeable. In fact, you cannot set folder or file permissions to be 777 when running suphp or phpsuexec - the highest permissions are 755 for both folders and files.

==Change your WHMCS Admin Folder name==

Malicious users who visit your site and recognise a WHMCS install will know that they can try logging into your admin area via the admin folder. To protect against this, you can rename the admin folder name to any name you like. You cannot move the folder - only rename it. You can then tell WHMCS what the name of that folder is for the links in admin notification emails by adding the following line to your configuration.php file:<br />

$customadminpath = "myadminname";

Replace "myadminname" above with the new name you just gave to your admin folder.

Please note that if you have already created a cron job, or one has been created for you, you will need to update the path on the cron as well.

Example: php -q /home/mylogin/public_html/secure/myadminname/cron.php

[[Installation|<< Back to Installation Overview]]

Reseller Central

2009-03-18T11:57:37Z

Joe: /* Configuring your Reseller Central Packages */

== What is Reseller Central ==

Reseller Central is a Server Control panel that interfaces with WHM AND Plesk to create a more user friendly front end to control your clients.
Reseller Central is created, written and maintained by HostNine (http:/www.hostnine.com)

This step by step guide explains how to setup your WHMCS to work with the Reseller Central system offered by HostNine. There are two things you need to do, the first is to configure a server and then the next is to configure your packages.

== Configuring the Reseller Central Server ==

#All server modules require a server, so begin by going to Configuration > Servers
#Next, click on the Add New Server link
#On the screen that is presented, next you need to enter the details about the server. There are only 2 fields required for the Reseller Central system and they are the server name and type, however you can enter your username and password if you wish to enter your Reseller Central username and password. In the type dropdown, make sure you select ResellerCentral.

== Configuring your Reseller Central Packages ==

#Go to Configuration > Products/Services
#Click on the Create New Product link at the top of the page (you will need to have at least one group setup first)
#On the following page, enter the new name for your Package and choose the group you want to assign it to
#After clicking the submit button, you will then see all the options for this new package - from here you need to configure the description shown on the order form, pricing and any other details
#Once you have selected the options you want for this package, you are ready to go to the Modules Settings tab to configure the module settings
#From the Server Type dropdown, choose "Resellercentral"
#The required fields for the module will then be displayed which include your API Key which you get from your Reseller Central panel, the Package Name as setup in the Reseller Central panel and the location you want the account to be setup in
#You should also choose at this point whether to setup a Windows or Linux hosting Account. ''(Windows hosting is only available in Texas)''
#You must complete all the fields and then click Save to save the changes to the product
#Finally, you need to create a custom field on the product to store the IP assigned by Reseller Central for each account - to do this go to the Custom Fields tab and add a custom field named "IP Address" - you can then use this in the email templates with the merge field [ProductCustom-IP Address]
#That's it! You have now completed the configuration of your Reseller Central Package.

===Email Templates for 3.7 and Reseller Central===
The email template should have {$service_custom_field_ipaddress} in the template to show the IP Address on the email template

== Offering Clients a Location Choice Dropdown (Optional) ==
* *'''Linux Hosting Only'''*

As you will be aware, when creating an account you can choose the location you want the account to be hosted in. With WHMCS, you can take that furthur and allow your client to choose where their hosting account is hosted. To do this, follow the steps below:

#Click the edit icon next to an existing Reseller Central package which you have created
#Next, click on the Custom Fields tab at the top of the page
#Now, in the Field Name box, enter "Website Location" - this is what is used to identify what the field defines so it must be entered exactly as shown
#In the field type dropdown, choose "Drop Down"
#Now in the Field Options box, enter a comma seperate list of the options you want to offer - below are all the options which you can copy and paste if you want to offer your clients all of them:<br><br>Illinois (USA),Iowa (USA),Virginia (USA),Texas (USA),Berkshire (UK),Georgia (USA),New York (USA),California (USA),Florida (USA),Singapore (ASIA)
#Next tick the Show on Order Form checkbox
#Finally, click Save Changes and that's it (it really is that easy!) - now this field will show during the order process and the value your customer selects will overide the default setting on the Server Settings tab.

{{modules}}

Reseller Central

2009-03-18T11:56:26Z

Joe: /* Configuring the Reseller Central Server */

== What is Reseller Central ==

Reseller Central is a Server Control panel that interfaces with WHM AND Plesk to create a more user friendly front end to control your clients.
Reseller Central is created, written and maintained by HostNine (http:/www.hostnine.com)

This step by step guide explains how to setup your WHMCS to work with the Reseller Central system offered by HostNine. There are two things you need to do, the first is to configure a server and then the next is to configure your packages.

== Configuring the Reseller Central Server ==

#All server modules require a server, so begin by going to Configuration > Servers
#Next, click on the Add New Server link
#On the screen that is presented, next you need to enter the details about the server. There are only 2 fields required for the Reseller Central system and they are the server name and type, however you can enter your username and password if you wish to enter your Reseller Central username and password. In the type dropdown, make sure you select ResellerCentral.

== Configuring your Reseller Central Packages ==

#Go to Configuration > Products & Services '''''(there is no such option like 'Products & Services', there is only 'Products/Services' i bilive that's we talking about...)'''''
#Click on the Create New Product link at the top of the page (you will need to have at least one group setup first)
#On the following page, enter the new name for your Package and choose the group you want to assign it to
#After clicking the submit button, you will then see all the options for this new package - from here you need to configure the description shown on the order form, pricing and any other details
#Once you have selected the options you want for this package, you are ready to go to the Server Settings tab to configure the module settings '''''(there is no such tab like 'Server Settings', there is only 'Module Settings' i bilive that's we talking about...)'''''
#From the Server Type dropdown, choose "Resellercentral"
#The required fields for the module will then be displayed which include your API Key which you get from your Reseller Central panel, the Package Name as setup in the Reseller Central panel and the location you want the account to be setup in
#You should also choose at this point whether to setup a Windows or Linux hosting Account. ''(Windows hosting is only available in Texas)''
#You must complete all the fields and then click Save to save the changes to the product
#Finally, you need to create a custom field on the product to store the IP assigned by Reseller Central for each account - to do this go to the Custom Fields tab and add a custom field named "IP Address" - you can then use this in the email templates with the merge field [ProductCustom-IP Address]
#That's it! You have now completed the configuration of your Reseller Central Package.

===Email Templates for 3.7 and Reseller Central===
The email template should have {$service_custom_field_ipaddress} in the template to show the IP Address on the email template

== Offering Clients a Location Choice Dropdown (Optional) ==
* *'''Linux Hosting Only'''*

As you will be aware, when creating an account you can choose the location you want the account to be hosted in. With WHMCS, you can take that furthur and allow your client to choose where their hosting account is hosted. To do this, follow the steps below:

#Click the edit icon next to an existing Reseller Central package which you have created
#Next, click on the Custom Fields tab at the top of the page
#Now, in the Field Name box, enter "Website Location" - this is what is used to identify what the field defines so it must be entered exactly as shown
#In the field type dropdown, choose "Drop Down"
#Now in the Field Options box, enter a comma seperate list of the options you want to offer - below are all the options which you can copy and paste if you want to offer your clients all of them:<br><br>Illinois (USA),Iowa (USA),Virginia (USA),Texas (USA),Berkshire (UK),Georgia (USA),New York (USA),California (USA),Florida (USA),Singapore (ASIA)
#Next tick the Show on Order Form checkbox
#Finally, click Save Changes and that's it (it really is that easy!) - now this field will show during the order process and the value your customer selects will overide the default setting on the Server Settings tab.

{{modules}}

Linking to WHMCS

2009-02-21T16:39:06Z

Joe: /* Custom Order Form Link */

It is very common for users of WHMCS to want to link to WHMCS from their website. This can be in the form of an order link, or with a form that either takes the user straight to the domain checking process to check the availability of the domain they want or to login.

With WHMCS, this is made easy as all the code you need is provided to you customised and ready to insert into your website by simply going to Utilities > Integration Code.

==Order Links==

You can obtain direct order links for products from the product configuration screen. A direct order link takes the user straight into step two of the order process with the product or service preselected. This is used for order links on your site for specific products. The link looks something like this:

http://demo.whmcs.com/cart.php?a=add&pid=1

You can also link directly to an individual product group. The link looks something like this:

http://demo.whmcs.com/cart.php?&gid=1

==Custom Order Form Link==

To link to a specific order form template. The link looks something like this:

http://demo.whmcs.com/cart.php?ordertemplate=xxxxxxxx

==Setting the Language/Template via the URL==

You can set the language or template to be displayed to the user with the link you use to WHMCS. This is done with links such as:

http://demo.whmcs.com/index.php?systemtemplate=portal

http://demo.whmcs.com/index.php?language=Spanish

http://demo.whmcs.com/index.php?systemtemplate=portal&language=Spanish

http://demo.whmcs.com/cart.php?systemtemplate=portal&language=English&gid=1

http://demo.whmcs.com/cart.php?systemtemplate=portal&language=Spanish&a=add&pid=1

These can be combined, used on any page and used with the direct order links

==Showing Announcements on your Site==

You can display the announcements on any page of your site using the code below. This will display the latest 3 announcements set to published status.

<?php
include("support/dbconnect.php");
include("support/includes/functions.php");
$query = "SELECT * FROM tblannouncements WHERE published='on' ORDER BY date DESC LIMIT 0,3";
$result = mysql_query($query);
while ($data = mysql_fetch_array($result)) {
$id = $data["id"];
$date = $data["date"];
$title = $data["title"];
$announcement = $data["announcement"];
<nowiki>$date = fromMySQLDate($date);
echo("<p><font color=#cccccc>$date</font> - <b>$title</b><br>$announcement</p>");</nowiki>
}
?>

You should replace the word support in the first two lines where it includes files from the WHMCS folder with the path to your WHMCS directory.

==Showing The Login Form on your Site==

You can display the login form on any page of your site using the code below. This will display the required login form to login to the WHMCS Client Area.

<pre>
<form method="post" action="http://www.yourdomain.com/whmcs/dologin.php?goto=clientarea">
Email Address: <input type="text" name="username" size="50">
Password: <input type="password" name="password" size="20">
<input type="submit" value="Login">
</form>
</pre>

You should replace the URL of the form action to the path to your WHMCS directory.

Linking to WHMCS

2009-02-21T16:37:58Z

Joe: /* Order Links */

It is very common for users of WHMCS to want to link to WHMCS from their website. This can be in the form of an order link, or with a form that either takes the user straight to the domain checking process to check the availability of the domain they want or to login.

With WHMCS, this is made easy as all the code you need is provided to you customised and ready to insert into your website by simply going to Utilities > Integration Code.

==Order Links==

You can obtain direct order links for products from the product configuration screen. A direct order link takes the user straight into step two of the order process with the product or service preselected. This is used for order links on your site for specific products. The link looks something like this:

http://demo.whmcs.com/cart.php?a=add&pid=1

You can also link directly to an individual product group. The link looks something like this:

http://demo.whmcs.com/cart.php?&gid=1

==Custom Order Form Link==

To link to a specific orderform template. The link looks something like this:

http://demo.whmcs.com/cart.php?ordertemplate=xxxxxxxx

==Setting the Language/Template via the URL==

You can set the language or template to be displayed to the user with the link you use to WHMCS. This is done with links such as:

http://demo.whmcs.com/index.php?systemtemplate=portal

http://demo.whmcs.com/index.php?language=Spanish

http://demo.whmcs.com/index.php?systemtemplate=portal&language=Spanish

http://demo.whmcs.com/cart.php?systemtemplate=portal&language=English&gid=1

http://demo.whmcs.com/cart.php?systemtemplate=portal&language=Spanish&a=add&pid=1

These can be combined, used on any page and used with the direct order links

==Showing Announcements on your Site==

You can display the announcements on any page of your site using the code below. This will display the latest 3 announcements set to published status.

<?php
include("support/dbconnect.php");
include("support/includes/functions.php");
$query = "SELECT * FROM tblannouncements WHERE published='on' ORDER BY date DESC LIMIT 0,3";
$result = mysql_query($query);
while ($data = mysql_fetch_array($result)) {
$id = $data["id"];
$date = $data["date"];
$title = $data["title"];
$announcement = $data["announcement"];
<nowiki>$date = fromMySQLDate($date);
echo("<p><font color=#cccccc>$date</font> - <b>$title</b><br>$announcement</p>");</nowiki>
}
?>

You should replace the word support in the first two lines where it includes files from the WHMCS folder with the path to your WHMCS directory.

==Showing The Login Form on your Site==

You can display the login form on any page of your site using the code below. This will display the required login form to login to the WHMCS Client Area.

<pre>
<form method="post" action="http://www.yourdomain.com/whmcs/dologin.php?goto=clientarea">
Email Address: <input type="text" name="username" size="50">
Password: <input type="password" name="password" size="20">
<input type="submit" value="Login">
</form>
</pre>

You should replace the URL of the form action to the path to your WHMCS directory.

Further Security Steps

2009-01-29T16:41:15Z

Joe: /* Change your WHMCS Admin Folder name */

The guide below describes various extra steps you can take to further secure your WHMCS system.

==Move the attachments, downloads & templates_c folders==

The three folders "attachments", "downloads" and "templates_c" need to be writeable by WHMCS and therefore require the permissions 777 (writeable by all). When folders have this permission level it is safer to place the folders outside of the public accessible folder tree on your website. WHMCS allows you to do this. If you do move the folders, then you must tell WHMCS where they have been moved to by adding the following lines to your configuration.php file:

$templates_compiledir = "/home/whmcs/templates_c/";
$attachments_dir = "/home/whmcs/attachments/";
$downloads_dir = "/home/whmcs/downloads/";

Note that if you are running suphp or phpsuexec you should not make the mode changes as the folders will already be writeable. In fact, you cannot set folder or file permissions to be 777 when running suphp or phpsuexec - the highest permissions are 755 for both folders and files.

==Change your WHMCS Admin Folder name==

Malicious users who visit your site and recognise a WHMCS install will know that they can try logging into your admin area via the admin folder. To protect against this, you can rename the admin folder name to any name you like. You cannot move the folder - only rename it. You can then tell WHMCS what the name of that folder is for the links in admin notification emails by adding the following line to your configuration.php file:<br />

$customadminpath = "myadminname";

Replace "myadminname" above with the new name you just gave to your admin folder.

Also remember to reissue your whmcs license after doing this, otherwise, you will be unable to login to your admin area. To do this, login to your client area at www.whmcs.com/clients, click on 'My Licenses', click on the edit icon next to your license and then on the 'Reissue License' button.

Finally, if you have already created a cron job, or one has been created for you, you will need to update the path on the cron as well.

Example: php -q /home/mylogin/public_html/secure/myadminname/cron.php

[[Installation|<< Back to Installation Overview]]

Installing WHMCS

2008-12-08T12:56:50Z

Joe: Protected "Installing WHMCS" [edit=sysop:move=sysop]

==Downloading WHMCS==

To download WHMCS, login to our client area at [http://www.whmcs.com/clients/ www.whmcs.com/clients] You should then do the following to download the system:

*Click the My Licenses link
*Select one of your active license keys
*Choose the latest version to download from the available Downloads

==Installing Ioncube==

WHMCS is encrypted using the Ioncube system. There are therefore two ways to use WHMCS. You can use the runtime decoders or you can install the Ioncube decoders on your server in php.ini. The first way is easy, all you have to do is upload the ioncube folder included in the zip file download to your WHMCS directory. The second is slightly more difficult so here is a tutorial on how to do it.

You WILL require root access to the server in order to do this.

#Download the latest loaders to your computer from http://www.ioncube.com/loaders.php
#Extract the contents of the archived file on your local PC to a folder of your choice.
#Upload the folder IONCUBE via FTP to your domain webspace
#Now establish an SSH connection with server using a suitable client (e.g. Putty for PC's or Terminal on Mac). This is usually done using the command: SSH rootusername@yourserver.com (you will then be asked for your password).
#You will need to browse to the public folder where you uploaded the IONCUBE directory (search internet for change and view directory commands in Unix).
#Move the ioncube folder to a permanent location by entering: mv ioncube /usr/local
#Next, you need to locate the php.ini file, to do this enter: locate php.ini - You should find it is in /usr/local/lib/php.ini. Now that you know the location of php.ini you need to edit it. pico /usr/local/lib/php.ini
#Now find where other zend extentions are in the file: ctrl + w: zend_extension
#Paste in your new line for ioncube loader: zend_extension = /usr/local/ioncube/ioncube_loader_lin_x.so (Replace x with your version of PHP eg. 4.4)
#Save the changes: ctrl + X then Y and enter
#Restart the web server to take effect: /etc/init.d/httpd restart

That's it! Ioncube is now installed on your server! You should now see a section in your PHP Info page that says:

Additional Modules
Module Name ionCube Loader

==Installing WHMCS==

Installing WHMCS is very simple. The following steps will guide you through the process:

#Unzip the contents of the zip file to a folder on your computer
#Rename the file configuration.php.new to configuration.php
#Upload the entire whmcs folder to your website in binary mode - you can rename the folder to whatever you like (billing,clients,etc)
#If you don't have Ioncube installed on your server then simply upload the runtime loaders folder named "ioncube" also included in the zip file to the whmcs directory
#CHMOD the following folders & files ''(unless your php is SUphp or phpsuexec)'':
/configuration.php 777
/attachments 777
/downloads 777
/templates_c 777
#Run the installation script at http://www.yourdomain.com/whmcs/install/install.php (choose New Install on Step 2) - This will guide you through the rest of the setup process. On the last step, it will ask you to setup a cron job and provide you with the exact command you need to use. If you fail to do this, then automated tasks will not be performed.
#Once completed, delete the install folder from your web server and CHMOD the configuration.php file back to 644.

==Post Installation Suggested Steps==

After installation is completed, we recommend that you go through and configure your new WHMCS system in the following order:

#Login to the Admin Area and configure your General Settings (Configuration > General Settings)
#Setup your Payment Gateways (Configuration > Payment Gateways)
#Setup your Products & Services (Configuration > Products/Services)
#Configure your Domain Pricing (Configuration > Domain Pricing)
#Setup your Support Ticket Departments (Configuration > Support Departments)
#Setup email piping so you can manage tickets using the WHMCS Support Desk - for full instructions on this please see the relevant article
#Ensure the WHMCS Cron Job is setup and configure automated tasks (Configuration > Automation Settings)
#Place some test orders on your website to check everything works as expected

Installing WHMCS

2008-12-08T12:40:45Z

Joe: Reverted edits by Kalsulesunil (Talk); changed back to last version by Torbz

Hooks

2008-12-06T15:57:06Z

Joe:

Action hooks allow you to write your own PHP code that will run when specific actions occur in WHMCS. There is a function for each action that supports hooks.

To view the available action hooks, open the file includes/actionhooks.php (The variables available in a specific function are listed in the comments for that function).

Invalid code here will will cause WHMCS to fail so ensure your code is valid.

Template Syntax

2008-08-19T15:35:53Z

Joe: /* More Information */

The basic template syntax can be seen by looking at the templates. Template files simply use regular HTML along with tags for where the WHMCS data is inserted into them. All pages have specific variables which you can use. To view a complete list of variables available on a given page, enter the following tag into the template file:

{debug}

When you next access that template file after adding this code, a popup window will appear showing you all the different variables which you can use on the page. Variables can be accessed using the {$variable} syntax.

==Common Template Variables Available on All Pages==

The following is a list of template variables available for use in all the template files of WHMCS

*{$companyname} - Company Name
*{$pagetitle} - Current Pages Title
*{$template} - Template Name
*{$charset} - Current Charset Setting
*{$todaysdate} - Formatted Date
*{$systemurl} - URL to WHMCS System
*{$loggedin} - True if logged in

*{$clientsdetails.id} - Currently Logged in Users Details
*{$clientsdetails.firstname}
*{$clientsdetails.lastname}

==Displaying Text to Logged In Users Only==

To display something on the page only if a user is logged in, use the following syntax:

{if $loggedin}
User is logged in so display client only information
{else}
User is not logged in so display this
{/if}

==Displaying Text if Certain Conditions Are Met==

In a similar vein it can be useful to display things only is certain conditions are met. For example you might want to display card scheme logos associated with your different payment gateways, or show information based upon what is displayed on the page. This is done using if commands:

{if $gateway.name eq "PayPal"}We accept PayPal{/if}

Would display the message "We accept PayPal" if that option is available on the checkout page. This can be used for any variable.

==More Information==

For furthur documentation on template customisations, see the official Smarty documentation @ http://smarty.net/docs.php

Linking to WHMCS

2008-08-13T20:37:19Z

Joe: /* Order Links */

It is very common for users of WHMCS to want to link to WHMCS from their website. This can be in the form of an order link, or with a form that either takes the user straight to the domain checking process to check the availability of the domain they want or to login.

With WHMCS, this is made easy as all the code you need is provided to you customised and ready to insert into your website by simply going to Utilities > Integration Code.

==Order Links==

You can obtain direct order links for products from the product configuration screen. A direct order link takes the user straight into step two of the order process with the product or service preselected. This is used for order links on your site for specific products. The link looks something like this:

http://demo.whmcs.com/cart.php?a=add&pid=1

You can also link directly to an individual product group. The link looks something like this:

http://demo.whmcs.com/cart.php?&gid=1

==Setting the Language/Template via the URL==

You can set the language or template to be displayed to the user with the link you use to WHMCS. This is done with links such as:

http://demo.whmcs.com/index.php?systemtemplate=portal

http://demo.whmcs.com/index.php?language=Spanish

http://demo.whmcs.com/index.php?systemtemplate=portal&language=Spanish

http://demo.whmcs.com/cart.php?systemtemplate=portal&language=English&gid=1

http://demo.whmcs.com/cart.php?systemtemplate=portal&language=Spanish&a=add&pid=1

These can be combined, used on any page and used with the direct order links

==Showing Annoucements on your Site==

You can display the announcements on any page of your site using the code below. This will display the latest 3 announcements set to published status.

<?php
include("support/dbconnect.php");
include("support/includes/functions.php");
$query = "SELECT * FROM tblannouncements WHERE published='on' ORDER BY date DESC LIMIT 0,3";
$result = mysql_query($query);
while ($data = mysql_fetch_array($result)) {
$id = $data["id"];
$date = $data["date"];
$title = $data["title"];
$announcement = $data["announcement"];
<nowiki>$date = fromMySQLDate($date);
echo("<p><font color=#cccccc>$date</font> - <b>$title</b><br>$announcement</p>");</nowiki>
}
?>

You should replace the word support in the first two lines where it includes files from the WHMCS folder with the path to your WHMCS directory.

Linking to WHMCS

2008-08-13T20:30:46Z

Joe: /* Setting the Language/Template via the URL */

It is very common for users of WHMCS to want to link to WHMCS from their website. This can be in the form of an order link, or with a form that either takes the user straight to the domain checking process to check the availability of the domain they want or to login.

With WHMCS, this is made easy as all the code you need is provided to you customised and ready to insert into your website by simply going to Utilities > Integration Code.

==Order Links==

You can obtain direct order links for products from the product configuration screen. A direct order link takes the user straight into step two of the order process with the product or service preselected. This is used for order links on your site for specific products. The link looks something like this:

http://demo.whmcs.com/cart.php?a=add&pid=1

==Setting the Language/Template via the URL==

You can set the language or template to be displayed to the user with the link you use to WHMCS. This is done with links such as:

http://demo.whmcs.com/index.php?systemtemplate=portal

http://demo.whmcs.com/index.php?language=Spanish

http://demo.whmcs.com/index.php?systemtemplate=portal&language=Spanish

http://demo.whmcs.com/cart.php?systemtemplate=portal&language=English&gid=1

http://demo.whmcs.com/cart.php?systemtemplate=portal&language=Spanish&a=add&pid=1

These can be combined, used on any page and used with the direct order links

==Showing Annoucements on your Site==

You can display the announcements on any page of your site using the code below. This will display the latest 3 announcements set to published status.

<?php
include("support/dbconnect.php");
include("support/includes/functions.php");
$query = "SELECT * FROM tblannouncements WHERE published='on' ORDER BY date DESC LIMIT 0,3";
$result = mysql_query($query);
while ($data = mysql_fetch_array($result)) {
$id = $data["id"];
$date = $data["date"];
$title = $data["title"];
$announcement = $data["announcement"];
<nowiki>$date = fromMySQLDate($date);
echo("<p><font color=#cccccc>$date</font> - <b>$title</b><br>$announcement</p>");</nowiki>
}
?>

You should replace the word support in the first two lines where it includes files from the WHMCS folder with the path to your WHMCS directory.

2008-05-22T11:39:00Z

Joe:

OnlineNIC Errors

2008-05-22T11:35:27Z

Joe: /* Error Codes */

Email Templates

2008-05-14T17:56:51Z

Joe:

The email templates allow you to customise the messages that go out to your customers when actions occur inside WHMCS. Every email that goes out to a customer can be customised here.

To edit an email template, go to Configuration > Email Templates and click the edit icon next to the template you want to change.

You can also toggle plain text vs. HTML email sending on a per email basis from the editor page.

To view a list of the data that you can include in your emails, click the "Merge Fields" button at the bottom of the editing page. The merge fields you can use depends upon what the email is related to so you can't always use the fields from one template in another - only those of the same group.

Support Center

2008-05-05T17:27:05Z

Joe: /* Allowed File Attachments */

WHMCS includes a fully featured helpdesk for your clients. This includes announcements, downloads, a knowledgebase and a ticketing system.

==Announcements==

The announcements system along with showing announcements in the client area will also output announcements into an XML RSS Feed for use in readers and on other websites. For this to work, all you need to do is ensure the announcements.xml file is CHMOD 777 (writeable).

==Downloads==

You can add downloads to the site for your users. These can either be hosted locally or remotely. For remotely hosted files, simply enter the full URL to the files starting with http:// in the file location field. For local files it should just be the filename.

Downloads can be either public or private and if private, only users who are logged in will have access to them. You can also specify certain products which can be downloaded only once the associated package is purchased.

==Knowledgebase==

The knowledgebase allows you to create a collection of commonly asked questions and there answers. You can group these into categories and set them to be either visible or private (admin only). The client area offers the user the choice of browing through the articles in your KB or searching based on keywords they enter.

==Support Tickets==

The support ticket system is a fully featured ticket desk that allows you to handle all communication with your clients. Featuring threaded discussions, private notes, ticket flagging, varying priority levels, auto inactive ticket closing and much much more... Admins can be assigned on a per department basis so they have access only to the area they are meant to be dealing with.

In order to have emails from users automatically import into the ticket system as tickets, you need to configure [[Email Piping]]

===Ticket Flagging===

Flagging a ticket to another admin is useful if you want to bring the ticket to the attention of another staff member. Flagged tickets appear highlighted and emboldended to the staff member they are flagged to. To do this, open the ticket and on the Options tab, simply choose the admin user in the Flag dropdown menu then click Save.

===Predefined Ticket Replies===

Predefined ticket replies are useful if you get asked the same questions repeatedly via support tickets. With a predefined reply, this can be loaded into the reply box when replying to a users ticket and modified as required to answer the users question.

====Adding a Predefined Reply====

To setup a predefined reply, go to Support Center > Predefined Replies. You will first need to setup at least one category for predefined replies, for example "Pre-Sales", and then you can create your predefined replies inside the appropriate category.

====Using a Predefined Reply====

To use a predefined ticket reply when relpying to a users ticket, when viewing the ticket click on the Reply tab near the top of the page and then click the "Insert Predefined Ticket Reply" link located immediately below the text area for entering your reply. A popup window will appear allowing you to select the reply you want to use and it will then be loaded into the reply message box once selected. You can then edit the reply as required to customise it to the user and then click Reply button as normal.

===Allowed File Attachments===

Support tickets and replies allow a file to be uploaded along with them for if the user needs to send you something or if you need to send the user something.

The list of allowed file types is configured by going to Configuration > General Settings > Support Tickets. By default, the allowed file types are .jpg, .gif, .jpeg, and .png (ie. image files). It is not possible to allow the user to upload PHP files due to the security risks this creates. You can add new allowed file types to the list such as .pdf, .zip, etc... Just add them into the allowed extensions field seperating each allowed ending with a comma.

NOTE: The file upload restrictions do not apply to admin users and an admin user can attach any type of file to a ticket.

Importing Data

2008-04-30T10:16:18Z

Joe: /* Common Errors */

We understand that the majority of companies already have a billing system in place to manage their hosting clients and are worried by the difficulties of switching to a new billing system. With that in mind, we provide the following guides and automation scripts in order to make importing easy.

==Automated Import Scripts==
The following are automated import scripts from competing applications so if you are already running one of these switching is easy.
*Modernbill V4.4.x & V5
*ClientExec V2.8.x & V3
*WHMAutoPilot V2.5.x & V3.x
*AWBS V2.5 or later
*Lpanel V1.7 or later
*WhoisCart V2.2.x
*AccountLab Plus V2.8.x
*PerlBill (Clients Only)
You can download these from the Import Scripts section of our client area.

==Manual Data Entry==
===Manual Client Entry===
To manually import your clients and their hosting accounts, you should use the following steps. Instructions on manually adding a domain name can be found below.
#Go to Clients > Add New Client
#Fill out the clients details - the minimum required fields are First & Last Name, Email Address & Password
#Click Add Client
Once the client has been added, you can proceed to add their hosting accounts. You do this as follows:
#After adding the client, you will be shown the clients summary page for the client you just added
#From here, click the "Add New Order" link in the Quick Links section of the page
#Tick the boxes labelled "Don't Send Order Confirmation Email" and "Don't Generate Invoice" so that the user is not notified about the order you are adding
#Choose a package and then click Continue
#If the package comes with a domain, enter the users domain. If the domain is registered with you, you should choose the transfer domain option even though you will not be transferring it today. Alternatively, choose the use own domain option if the user manages their domain and doesn't have it registered with you. Then click Continue.
#On the next step, choose the billing cycle, any addons the user has, configurable options, etc... Then click Continue.
#You will now be presented with a summary of the order. If you are happy with the order, click the Continue button to complete the order and add it to WHMCS.
#You will now been shown the order screen and it will be set as Pending. Proceed to mark the order as active without attempting to automatically create the account or register domain.
#Now as the final step, you must go into the products and/or domains page and set the correct payment method and next due date. To do this, from the order screen, click on the link in the Type column of the products ordered - this will take you straight to their details screen. From here, you can choose the payment method, enter the next due payment date (and for hosting accounts set the correct server and enter the username/password for the account to allow suspensions/terminations to occur)

===Manual Existing Domain Entry===
#On the client summary page click the "Add New Order" link in the Quick Links section of the page.
#Tick the boxes labelled "Don't Send Order Confirmation Email" and "Don't Generate Invoice" so that the user is not notified about the order you are adding.
#Select Domain Registration.
#Select "I want to transfer my domain" even though you will not be transferring it today and enter the domain name.
#If an EPP code is required, enter a fake one (e.g. 12345).
#Configure any extras as required and click continue.
#You will now be presented with a summary of the order. If you are happy with the order, click the Continue button to complete the order and add it to WHMCS.
#You will now been shown the order screen and it will be set as Pending. Select your registrar, untick the "Send to Registrar" and "Send Confirmation Email" options before clicking "Accept Order".
#Finally you should go to the domain's information page to enter the correct expiry and due dates.

You have now finished adding your client. By following the steps above, your client will have not been notified that you've added them and will now be invoiced by WHMCS prior to the next due date for the items in their account.

==WHM/cPanel Import Script==
The WHM Import Tool can be accessed using the Utilities menu. This will allow you to import accounts from your existing cPanel/WHM servers. It can save hours of time and is very easy to use. Here is how:

#You must first ensure you have setup the server you wish to import accounts from in Configuration > Manage Servers
#Next, go to Utilities > WHM Import Script
#Now choose the server you want to import accounts from in the dropdown box
#A list of the accounts on that server will now be displayed
#From here you can select the accounts you wish to import - you can select all the accounts by clicking the checkbox in the header row
#Then simply click the Import button at the bottom of the page an the accounts will be imported

Accounts created by the import will be created a client account with the name "cpanelusername Owner" and a random 7 digit password. Domains and their usernames will then be imported and they will be assigned to the correct server and package in WHMCS. Intially all accounts will be set as free accounts and you will need to go through and specify their various pricing information and payment methods. The data imported by the import tool will mean that all the cPanel account functions are possible including Suspend/Unsuspend/Terminate & Change Password.

Quite often you will then need to move the accounts around and group more than one domain under one client. To do this, see the "Moving a Product/Service to another Client" article in the Products Management section.

===Common Errors===

Import Failed - This error occurs when an account cannot be assigned to a package in WHMCS. This happens when there is no package setup for the WHM Package Name in WHMCS. Before performing an import, you must ensure you have setup all the packages in use on the server by accounts you are wanting to import on a package in WHMCS. To do this, go to Configuration > Products/Services, create or edit an existing product and enter the WHM Package Name such as "demohost_Starter" in the Package Name field on the modules settings tab.

Documentation Home

2008-04-16T16:10:51Z

Joe: /* Getting Started */

__NOTOC__

Welcome to the WHMCSwiki. This is your one stop resource for help, guides, tips and addons for your WHMCS system. Before submitting a ticket, be sure to check here for the answer to your question. And if you find something that isn't covered, feel free to add it in!

<br />

<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="48%" valign="top">

==Getting Started==
* '''[[System Requirements]]'''
* '''[[Installing WHMCS]]'''
* '''[[Furthur Security Steps]]'''
* '''[[Importing Data]]'''
* '''[[Licensing]]'''
* '''[[Common Troubleshooting Tips]]'''

==Using WHMCS & Howto's==
* '''[[Client Management]]'''
* '''[[Order Management]]'''
* '''[[Products Management]]'''
* '''[[Domains Management]]'''
* '''[[Custom Fields]]'''
* '''[[Transactions]]'''
* '''[[Invoicing]]'''
* '''[[Messages/Emails]]'''
* '''[[Support Center]]'''
* '''[[Affiliates]]'''
* '''[[System Utilities]]'''
* '''[[Configuration]]'''
* '''[[Products and Services]]'''
* '''[[Servers]]'''
* '''[[Tax/VAT]]'''
* '''[[Administrators and Permissions]]'''
* '''[[Promotions]]'''
* '''[[Security/Ban Control]]'''

==API==
* '''[[API:About|About]]'''
* '''[[API:Example Usage|Example Usage]]'''
* '''[[API:Functions|Functions]]'''

</td><td width="4%"></td><td width="48%" valign="top">

==Customising WHMCS==
* '''[[Linking to WHMCS]]'''
* '''[[Client Area Template Files]]'''
* '''[[Template Syntax]]'''
* '''[[Order Form Templates]]'''
* '''[[PDF Invoice]]'''
* '''[[Creating Pages]]'''
* '''[[Language Files]]'''
* '''[[Creating Modules]]'''
* '''[[Action Hooks]]'''

==Modules==
* '''[[Payment Gateways]]'''
* '''[[Server Modules]]'''
* '''[[Domain Registrars]]'''
* '''[[Fraud Protection]]'''
* '''[[Admin Modules]]'''
* '''[[Reports]]'''
* '''[[Other]]'''

==Contributions==
'''[[Contribution convention|Contribution page guidelines]]'''
* '''[[:Category:Contributions|All contributions]]'''
** [[:Category:Admin-side Contributions|Admin-side contributions]]
** [[:Category:User-side Contributions|User-side contributions]]
** [[:Category:Theme Contributions|Theme contributions]]
** [[:Category:Official Contributions|Official contributions]] (created by WHMCS developers)

==WHMCS Links==
* '''[http://whmcs.com/demo.php Demonstration install]'''
* '''[http://forum.whmcs.com/ Community forums]'''
* '''[https://www.whmcs.com/clients/login.php Client area]'''

</td></tr></table>

Maintenance

2008-04-16T16:10:31Z

Joe: New page: ==Resetting your database== After you successfully install your billing system you should run through a series of tests. This includes creating client accounts and placing test orders with...

==Resetting your database==
After you successfully install your billing system you should run through a series of tests. This includes creating client accounts and placing test orders with your particular setup. Often, once you have finished your testing you will no longer want any of these clients or orders in your system. All you need to do is reset your system and all your test accounts will be removed.

You can empty all the tables that contain clients data by running the following SQL code on your database:

TRUNCATE `tblaccounts` ;

TRUNCATE `tblaffiliates` ;

TRUNCATE `tblaffiliatesaccounts` ;

TRUNCATE `tblannouncements` ;

TRUNCATE `tblcancelrequests` ;

TRUNCATE `tblclients` ;

TRUNCATE `tblcustomfields` ;

TRUNCATE `tbldomains` ;

TRUNCATE `tblemails` ;

TRUNCATE `tblhosting` ;

TRUNCATE `tblhostingaddons` ;

TRUNCATE `tblhostingconfigoptions` ;

TRUNCATE `tblinvoiceitems` ;

TRUNCATE `tblinvoices` ;

TRUNCATE `tblorders` ;

TRUNCATE `tblticketlog` ;

TRUNCATE `tblticketnotes` ;

TRUNCATE `tblticketreplies` ;

TRUNCATE `tbltickets` ;

Note: Resetting your database only deletes client accounts and information. You will not lose any configuration settings you have setup.

==Backing up your WHMCS Database==
It is strongly recommended that you backup your WHMCS Database regularly to ensure you always have a copy of your data should a server or system failure occur. Backing up the database is a very simply task with the built in backup tool. This is how to use it:

1. Login to your WHMCS Admin Area

2. Go to Utilities > Database Status

3. Click the Download Full Database Backup button at the top of the page

4. You should be prompted for a file to download. Save the file to your computer. Depending on the database size, this may take a few moments.

5. Once the download is complete you have now backed up your database.

==Restoring a Database Backup==
If you need to restore a backup of your database then you will need to use the following steps. If you have not already recreated your database, do so now. If your database is created, you must drop the existing WHMCS tables.

1. Log in to phpMyAdmin and select the database you want to restore the backup to

2. Click the SQL tab at the top

3. Click the Browse button toward the bottom of the page

4. Browse to find your backup file and then press Ok

5. Click Go

Documentation Home

2008-04-16T13:45:30Z

Joe: /* Getting Started */

__NOTOC__

Welcome to the WHMCSwiki. This is your one stop resource for help, guides, tips and addons for your WHMCS system. Before submitting a ticket, be sure to check here for the answer to your question. And if you find something that isn't covered, feel free to add it in!

<br />

<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="48%" valign="top">

==Getting Started==
* '''[[System Requirements]]'''
* '''[[Installing WHMCS]]'''
* '''[[Furthur Security Steps]]'''
* '''[[Importing Data]]'''
* '''[[Licensing]]'''
* '''[[Maintenace]]'''
* '''[[Common Troubleshooting Tips]]'''

==Using WHMCS & Howto's==
* '''[[Client Management]]'''
* '''[[Order Management]]'''
* '''[[Products Management]]'''
* '''[[Domains Management]]'''
* '''[[Custom Fields]]'''
* '''[[Transactions]]'''
* '''[[Invoicing]]'''
* '''[[Messages/Emails]]'''
* '''[[Support Center]]'''
* '''[[Affiliates]]'''
* '''[[System Utilities]]'''
* '''[[Configuration]]'''
* '''[[Products and Services]]'''
* '''[[Servers]]'''
* '''[[Tax/VAT]]'''
* '''[[Administrators and Permissions]]'''
* '''[[Promotions]]'''
* '''[[Security/Ban Control]]'''

==API==
* '''[[API:About|About]]'''
* '''[[API:Example Usage|Example Usage]]'''
* '''[[API:Functions|Functions]]'''

</td><td width="4%"></td><td width="48%" valign="top">

==Customising WHMCS==
* '''[[Linking to WHMCS]]'''
* '''[[Client Area Template Files]]'''
* '''[[Template Syntax]]'''
* '''[[Order Form Templates]]'''
* '''[[PDF Invoice]]'''
* '''[[Creating Pages]]'''
* '''[[Language Files]]'''
* '''[[Creating Modules]]'''
* '''[[Action Hooks]]'''

==Modules==
* '''[[Payment Gateways]]'''
* '''[[Server Modules]]'''
* '''[[Domain Registrars]]'''
* '''[[Fraud Protection]]'''
* '''[[Admin Modules]]'''
* '''[[Reports]]'''
* '''[[Other]]'''

==Contributions==
'''[[Contribution convention|Contribution page guidelines]]'''
* '''[[:Category:Contributions|All contributions]]'''
** [[:Category:Admin-side Contributions|Admin-side contributions]]
** [[:Category:User-side Contributions|User-side contributions]]
** [[:Category:Theme Contributions|Theme contributions]]
** [[:Category:Official Contributions|Official contributions]] (created by WHMCS developers)

==WHMCS Links==
* '''[http://whmcs.com/demo.php Demonstration install]'''
* '''[http://forum.whmcs.com/ Community forums]'''
* '''[https://www.whmcs.com/clients/login.php Client area]'''

</td></tr></table>

Payment Gateways

2008-03-23T14:34:27Z

Joe: /* Merchant Gateways */

The following is a list of the payment gateways that are supported.

==Merchant Gateways==
* Payflow Pro
* Authorize.net
* BluePay
* Quantum Gateway
* eWay
* eProcessingNetwork
* [[LinkPoint]]
* SecPay
* ProtX
* ProtX VPS Form
* PSIGate
* WorldPay Invisible
* NaviGate
* Merchant Partners
* Offline Credit Card

==Third Party Gateways==
* [[PayPal]]
* ChronoPay
* 2CheckOut
* [[Google CheckOut]]
* [[WorldPay]]
* E-Gold
* CyberBit
* F2B
* NoChex
* AlertPay
* Paymex
* CashU
* StormPay
* Paymate AU & NZ
* Payson
* BRPay
* Boleto
* MoneyBookers
* Mail In Payment
* Bank Transfer

WHMCS:Privacy policy

2008-03-20T22:03:17Z

Joe: /* Adding/Editing In the WHMCSWiki */

The information collected in the WHMCSWiki is similar to most websites you visit. When you choose to create a new page or edit an existing page, you should assume that this information, along with your contributions to the WHMCSWiki, will be retained forever.

===Adding/Editing===

When you add/edit any page in the WHMCSWiki, your user name and IP address are logged. If you are logged in when you add/edit, other users of the WHMCSWiki will only see your user name. Administrators of the WHMCSWiki will be able to determine your IP address. If you are not logged in when you add/edit a page on the WHMCSWiki, other users will see your IP address. If you are concerned about privacy, you may choose to log in. If you do choose to log in on a shared computer, make sure you log out at the end of each session otherwise other users will be able to make use of your identity to add/edit pages in the WHMCSWiki.

===Deleting Information===

Removing text from a page does not delete it completely. Anyone can use the page history to view a version of the page containing the deleted text. If an article is deleted, administrators may still be able to see the article content for a short while until the deletion becomes permanent.

===Passwords===

Passwords are the only protection you have against other users making use of your identity for adding/editing page in the WHMCSWiki. You should therefore choose a strong password and keep it safe. You must not knowingly release the password of another user, either directly or indirectly.

===Email===

You may give your email address when you create your user account and allow other users to send email to you through the WHMCSWiki. Your email address will not be exposed to other users unless you respond to their emails or, possibly, if their message to you bounces. If you send an email to another user through the WHMCSWiki, they will see your email address so that they can respond.

===Cookies===

The WHMCSWiki uses a session cookie and a persistent cookie. The session cookie is used to log in and holds your username and if you are logged in, your password in an encrypted form. The persistent cookie is kept for 30 days and holds your username. If you tick the "Remember me" checkbox when logging in it will also hold your password in an encrypted form. You can delete these cookies if you are using a shared computer and you don't want others users to view your username.

===Security===

We cannot guarantee that there will be no unauthorized access to the information you provide, although we take reasonable steps to prevent such access.

===Third parties===

We will not release or sell any private information we hold about you unless you consent to the release or we are required to release the information by law.