Page tree
Skip to end of metadata
Go to start of metadata

Overview

WHMCS offers an all-in-one billing and automation platform that automates all aspects of a web hosting business. This document describes how to install WHMCS on your cPanel account. You can purchase a license for WHMCS in the cPanel store. For more about managing WHMCS, read the WHMCS documentation.


Install as Site Software

Note:

  • Your hosting provide must enable this cPAddon in WHM's Install cPAddons Site Software interface (WHM >> Home >> cPanel >> Install cPAddons Site Software).
  • This cPAddon is only available in cPanel & WHM version 76 and later.
  • This cPAddon requires EasyApache 4.

For the one-click installations, log in to your cPanel account and perform the following steps:

Note:

The one-click installation requires you to setup a contact email address in cPanel's Contact Information interface (Home >> Preferences >> Contact Information).

  1. Navigate to cPanel's Site Software interface (cPanel >> Home >> Software >> Site Software).
  2. Under Automation, click WHMCS.
  3. Under the Install tab, select a domain from the Installation Domain menu and click Install.

For advanced configuration installations, log in to your cPanel account perform the following steps:

  1. Navigate to cPanel's Site Software interface (cPanel >> Home >> Software >> Site Software).
  2. Under Automation, click WHMCS.
  3. Under the Install tab, click Show Advanced Configuration.
  4. Select a domain from the Installation URL menu. You can enter directory if you desire.
  5. Enter an administrator username in the Admin User text box.
  6. Enter and confirm the new password in the appropriate text boxes.

    Notes:

    • The system evaluates the password that you enter on a scale of 100 points. 0 indicates a weak password, while 100 indicates a very secure password.
    • Some web hosts require a minimum password strength. A green password Strength meter indicates that the password is equal to or greater than the required password strength.
    • Click Password Generator to generate a strong password. For more information, read our Password & Security documentation.
  7. Enter your email address in the Email text box.
  8. Click Install.

Once the installation is complete, the interface will provide you with a success message and the WHMCS administration URL. When you browse to the URL, you can log in with the username and password you provide during the installation process. The WHMCS interface will prompt you to agree to the license agreement and then prompt you to enter your license key. If you need a license key, you can purchase one from the cPanel store.

Server Setup

Before you install WHMCS, you will need to install ionCube® and set up your database. 

Install ionCube

To install ionCube, follow the directions in our PHP Loader: ionCube 6 documentation.

Set up your database

After you install ionCube, follow the instructions in our MySQL Database Wizard documentation to set up your database.

Install WHMCS



Download WHMCS.

To download WHMCS, perform the following steps:

  1. Visit the WHMCS Download website.
  2. Enter your license key.
  3. Click Validate & Download to download the .zip file.




Prepare the files for upload.

Before you upload the WHMCS files to your website, you will need to unzip the downloaded file and rename a configuration file. To do so, perform the following steps:

  1. Locate the downloaded .zip file on your computer.
  2. Unzip the contents of the .zip file to a folder on your computer.
  3. In the WHMCS folder, rename the configuration.php.new file to configuration.php.




Upload the WHMCS folder to your website.

Upload the WHMCS folder to your website. You may rename the folder, if desired.

Note:

If the system returns an error, upload the file in binary mode.

Warning:

You cannot use the name admin for the WHMCS folder. The administration directory uses admin as a name.




Run the WHMCS Installer

To run the WHMCS installer, perform the following steps:

  1. To start the installation process, visit example.com/whmcs/install/install.php, where example.com represents your domain. If you uploaded the WHMCS files to a directory other than public_html, paste that path after your domain name in the URL.

  2. Follow the instructions to complete the installation.




Change permissions on the directories.

To change permissions on the directories, run the following commands:

chmod 400 configuration.php
chmod 777 attachments
chmod 777 downloads
chmod 777 templates_c




Delete the install directory.

To delete the install directory, perform the following steps.

  1. Navigate to the directory where you uploaded WHMCS.

  2. Delete the install directory.




Log in to your WHMCS account.

Log in to your WHMCS account with your license key.


Additional documentation