Difference between revisions of "Installing WHMCS"

From WHMCS Documentation

m (Installing WHMCS)
(Post Installation Suggested Steps)
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
==Downloading WHMCS==
 
==Downloading WHMCS==
 
#Visit http://download.whmcs.com/
 
#Click the Download button under the Full Release heading - this will be the latest release version
 
  
 
<div class="docs-alert-info">
 
<div class="docs-alert-info">
 
<span class="title">Reseller Customers</span><br />
 
<span class="title">Reseller Customers</span><br />
If your license key was obtained via a reseller and you therefore do not have a login for our members area, your reseller will be able to provide the latest WHMCS files to you''
+
If you obtained your license key from a reseller and you don't have a login for our members area, your reseller can provide the latest WHMCS files to you.
 
</div>
 
</div>
 +
 +
To download WHMCS:
 +
#Visit http://download.whmcs.com/
 +
#Click Download under the Full Release heading. This will be the latest release version.
  
 
==Installing Ioncube==
 
==Installing Ioncube==
  
WHMCS is encrypted using Ioncube to protect the source code. These days most servers/webhosts have Ioncube support compiled into the PHP build by default so you don't normally need to do anything extra for it. However if you find you do need to install Ioncube on your server, then you can find out how to do this in our [[Ioncube Installation Tutorial]]
+
WHMCS is encrypted using ionCube Loader® to protect the source code. Most hosting providers compile ionCube support into the PHP build by default.  
 +
 
 +
If you need to install ionCube on your server, see our [[Ioncube Installation Tutorial]].
  
 
==Creating a Database==
 
==Creating a Database==
WHMCS uses a MySQL database to store all settings and data. You will be asked to create one during the installation process, so best to create one beforehand. Technical information is detailed on the [[Database Setup]] page.
 
  
* [https://documentation.cpanel.net/display/68Docs/MySQL+Database+Wizard Creating databases in cPanel]
+
WHMCS uses a MySQL® database to store settings and data. You must create one during the installation process, or create one before you begin. For more information, see [[Database Setup]].
* [https://docs.plesk.com/en-US/17.0/customer-guide/advanced-website-databases.69535/ Created databases in Plesk]
+
 
 +
* [https://docs.cpanel.net/cpanel/databases/mysql-database-wizard/ Creating databases in cPanel & WHM]
 +
* [https://docs.plesk.com/en-US/17.0/customer-guide/advanced-website-databases.69535/ Creating databases in Plesk]
  
 
==Restrict Database Privileges==
 
==Restrict Database Privileges==
For day to day use, only the following database privileges are required. All others may be disabled.
 
  
*DELETE
+
Most tasks require the following database privileges:
*INSERT
+
 
*SELECT
+
*<tt>DELETE</tt>
*UPDATE
+
*<tt>INSERT</tt>
*LOCK TABLES
+
*<tt>SELECT</tt>
 +
*<tt>UPDATE</tt>
 +
*<tt>LOCK TABLES</tt>
  
Please note that installation, upgrading, activating, and deactivating modules require the following additional privileges.
+
Installation, upgrades, and activating and deactivating modules require the following additional privileges:
  
*ALTER
+
*<tt>ALTER</tt>
*CREATE
+
*<tt>CREATE</tt>
*DROP
+
*<tt>DROP</tt>
*INDEX
+
*<tt>INDEX</tt>
  
 
==Installing WHMCS==
 
==Installing WHMCS==
  
[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=nxd8VYu8u5s&list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb&index=2&t=0s|Watch Video Tutorial]]
+
<html><a href="https://www.youtube.com/watch?v=nxd8VYu8u5s&list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb&index=2&t=0s" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span>&nbsp;<img src="https://assets.whmcs.com/icons/youtube.png">&nbsp;</span></a></html>
  
 +
To install WHMCS, you can use the following process:
  
Installing WHMCS is very simple.  The following steps will guide you through the process:
+
*Unzip the contents of the <tt>.zip</tt> file to a folder on your computer.
 
+
*Rename the <tt>configuration.php.new</tt> to <tt>configuration.php</tt>.
*Unzip the contents of the zip file to a folder on your computer
+
*Upload the entire <tt>whmcs</tt> folder to your website. If you experience problems, try uploading the folder in binary mode.
*Rename the file configuration.php.new to configuration.php
+
*Optionally, rename the folder (for example, <tt>billing</tt>).
*Upload the entire whmcs folder to your website - if you experience problems, try uploading in binary mode
 
*Next you can rename the folder if desired (billing, clients, etc...)
 
 
<div class="docs-alert-warning">
 
<div class="docs-alert-warning">
<span class="title">Note:</span> The folder name "admin" is reserved for the administration area, so cannot be used as the installation directory name here</div>
+
<span class="title">Note:</span> The administration area uses an <tt>admin</tt> folder. You cannot use <tt>admin</tt> as the installation folder name.</div>
*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
+
*Navigate to the installation script at <tt>http://www.yourdomain.com/whmcs/install/install.php</tt> to run the installation. If you see an ionCube-related error message, perform the 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
+
*Follow the instructions to install WHMCS. This will include setting file permissions (see below), entering your license key, and setting up your primary administrator account.
  
When complete, delete the install folder from your web server and ensure the configuration.php file permissions are restricted.
+
When complete, delete the installation folder from your web server and check the <tt>configuration.php</tt> file permissions again.
  
 
<div class="docs-alert-warning">
 
<div class="docs-alert-warning">
<span class="title">Required file & folders permissions</span><br /><br />
+
<span class="title">Required file and folder permissions</span><br /><br />
/configuration.php          CHMOD 400 Readable<br />
+
<tt>/configuration.php          CHMOD 400 Readable<br />
/attachments                CHMOD 777 Writeable<br />
+
/attachments                CHMOD 777 Writable<br />
/downloads                  CHMOD 777 Writeable<br />
+
/downloads                  CHMOD 777 Writable<br />
/templates_c                CHMOD 777 Writeable<br /><br />
+
/templates_c                CHMOD 777 Writable</tt><br /><br />
The above applies unless your php is suPHP or PHPSuExec, it which case you directories should be more restrictive. If using DSO as your php handler, you must use 644 permissions.   It is important that permissions are limited to only the account that owns the web server process and that no other system accounts can read your configuration file or modify any files related to WHMCS.
+
The directory example permissions above may be overly permissive.  I.E. world read/write permission might not be necessary or appropriate for your hosting environment:
 +
* For suPHP or PHP suEXEC, you will need to restrict directories further. If you use DSO as your PHP handler, you must use <tt>644</tt> permissions.  
 +
* Limit access to only the account that owns the web server process. Make sure that no other system or user accounts can read your configuration file or modify any WHMCS-related files.
 
</div>
 
</div>
 +
 +
<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small>Have our professional services team install WHMCS for you.</small></em><span class="button">Services</span></a></html>
  
 
==Installing WHMCS In cPanel==
 
==Installing WHMCS In cPanel==
# Check with your server administrator or hosting provider that WHMCS has been installed using the ''Site Software'' feature of WHM. For more information, please see: https://help.whmcs.com/m/installation/l/1027775-configuring-whmcs-in-cpanel-site-software
+
 
# Login to cPanel and click the ''Site Software'' icon
+
If you use cPanel, you can also install WHMCS directly from within the interface. To do this:
# Click the ''WHMCS'' link
+
 
# Select the desired domain for the WHMCS application to be installed to:
+
# Check whether your hosting provider has installed WHMCS using the WHM ''Site Software'' feature. For more information, see [https://help.whmcs.com/m/installation/l/1027775-configuring-whmcs-in-cpanel-site-software| Configuring WHMCS in cPanel Site Software].
# Click ''Install''
+
# Log in to cPanel and click the ''Site Software'' icon.
# The installation may take up to 30 seconds and once completed, you will see a success confirmation along with a link to the login page and automatically generated default login credentials.
+
# Click ''WHMCS''.
# Visit the administration URL via the link provided to login for the first time.
+
# Select the domain where you want to install WHMCS.
# Upon logging in for the first time, you will be asked to review and agree to the End User License Agreement.
+
# Click ''Install''.
# You will subsequently be asked to activate WHMCS. This can be done either by entering an existing WHMCS license key if you already have one, or by following the link to purchase a new license.
+
# The installation may take up to 30 seconds. After it finishes, you will see a success message, a link to the login page, and automatically-generated default login credentials.
 +
# Visit the provided link to log in for the first time.
 +
# Upon logging in for the first time, the interface will prompt you to review and agree to the End User License Agreement.
 +
# The interface will prompt you to activate WHMCS. To do this, enter an existing WHMCS license key if you already have one, or follow the link to purchase a new license.
 
# After entering your license key, click ''Activate'' to validate and complete the process.
 
# After entering your license key, click ''Activate'' to validate and complete the process.
WHMCS is now installed and ready to use!
+
 
 +
WHMCS is now installed and ready to use.
  
 
==Post Installation Suggested Steps==
 
==Post Installation Suggested Steps==
  
After installation is completed, we recommend that you go through and configure your new WHMCS system in the following order:
+
After you complete installation, we recommend that you configure WHMCS in the following order:
  
#Perform the recommended [[Further Security Steps]]
+
#Perform the recommended [[Further Security Steps]].
#Login to the Admin Area and configure your General Settings (Setup > [[Configuration|General Settings]])
+
#Log in to the Admin Area and configure your general settings ('''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > [[Configuration|General Settings]]''').
#Setup your Payment Gateways (Setup  > [[Payment Gateways]])
+
#Set up your payment gateways ('''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup  > [[Payment Gateways]]''').
#Setup your Products & Services (Setup  > [[Products and Services]])
+
#Set up your products and services ('''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup  > [[Products and Services]]''').
#Configure your Domain Pricing (Setup  > [[Domains_Configuration|Domain Pricing]])
+
#Configure your domain pricing ('''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Pricing''' or, prior to WHMCS 8.0, '''Setup  > [[Domains_Configuration|Domain Pricing]]''').
#Setup your Support Ticket Departments (Setup  > [[Support_Center|Support Departments]])
+
#Set up your support ticket departments ('''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments''' or, prior to WHMCS 8.0, '''Setup  > [[Support_Center|Support Departments]]''').
#Setup email piping so you can manage tickets using the WHMCS Support Desk - for full instructions on this please see the [[Email Piping]] article
+
#Set up email piping so you can manage tickets using the WHMCS Support Desk. For more information, see [[Email Piping]].
#Ensure the WHMCS Cron Job is setup and configure automated tasks (Setup  > [[Automation Settings]])
+
#Make sure that the WHMCS cron job is set up and configure automated tasks ('''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' or, prior to WHMCS 8.0, '''Setup  > [[Automation Settings]]''').
#Place some test orders on your website to check everything works as expected
+
#Place some test orders on your website to check your setup.
  
[[File:Videotutorial.png‎|center|link=https://www.whmcs.com/get-support/video-tutorials/|Watch Video Tutorial]]
+
<html><a href="https://youtube.com/whmcs" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span>&nbsp;<img src="https://assets.whmcs.com/icons/youtube.png">&nbsp;</span></a></html>
  
For further guidance, you can watch video tutorials we have prepared for the above tasks @ [https://www.whmcs.com/get-support/video-tutorials/ www.whmcs.com/get-support/video-tutorials/]
+
For further guidance, watch our video tutorials: [https://youtube.com/whmcs https://youtube.com/whmcs]

Latest revision as of 17:16, 5 August 2020

Downloading WHMCS

Reseller Customers
If you obtained your license key from a reseller and you don't have a login for our members area, your reseller can provide the latest WHMCS files to you.

To download WHMCS:

  1. Visit http://download.whmcs.com/
  2. Click Download under the Full Release heading. This will be the latest release version.

Installing Ioncube

WHMCS is encrypted using ionCube Loader® to protect the source code. Most hosting providers compile ionCube support into the PHP build by default.

If you need to install ionCube on your server, see our Ioncube Installation Tutorial.

Creating a Database

WHMCS uses a MySQL® database to store settings and data. You must create one during the installation process, or create one before you begin. For more information, see Database Setup.

Restrict Database Privileges

Most tasks require the following database privileges:

  • DELETE
  • INSERT
  • SELECT
  • UPDATE
  • LOCK TABLES

Installation, upgrades, and activating and deactivating modules require the following additional privileges:

  • ALTER
  • CREATE
  • DROP
  • INDEX

Installing WHMCS

Watch the video tutorial for this feature  

To install WHMCS, you can use the following process:

  • Unzip the contents of the .zip file to a folder on your computer.
  • Rename the configuration.php.new to configuration.php.
  • Upload the entire whmcs folder to your website. If you experience problems, try uploading the folder in binary mode.
  • Optionally, rename the folder (for example, billing).
Note: The administration area uses an admin folder. You cannot use admin as the installation folder name.
  • Navigate to the installation script at http://www.yourdomain.com/whmcs/install/install.php to run the installation. If you see an ionCube-related error message, perform the ionCube steps above.
  • Follow the instructions to install WHMCS. This will include setting file permissions (see below), entering your license key, and setting up your primary administrator account.

When complete, delete the installation folder from your web server and check the configuration.php file permissions again.

Required file and folder permissions

/configuration.php CHMOD 400 Readable
/attachments CHMOD 777 Writable
/downloads CHMOD 777 Writable
/templates_c CHMOD 777 Writable


The directory example permissions above may be overly permissive. I.E. world read/write permission might not be necessary or appropriate for your hosting environment:

  • For suPHP or PHP suEXEC, you will need to restrict directories further. If you use DSO as your PHP handler, you must use 644 permissions.
  • Limit access to only the account that owns the web server process. Make sure that no other system or user accounts can read your configuration file or modify any WHMCS-related files.

Have our professional services team install WHMCS for you.Services

Installing WHMCS In cPanel

If you use cPanel, you can also install WHMCS directly from within the interface. To do this:

  1. Check whether your hosting provider has installed WHMCS using the WHM Site Software feature. For more information, see Configuring WHMCS in cPanel Site Software.
  2. Log in to cPanel and click the Site Software icon.
  3. Click WHMCS.
  4. Select the domain where you want to install WHMCS.
  5. Click Install.
  6. The installation may take up to 30 seconds. After it finishes, you will see a success message, a link to the login page, and automatically-generated default login credentials.
  7. Visit the provided link to log in for the first time.
  8. Upon logging in for the first time, the interface will prompt you to review and agree to the End User License Agreement.
  9. The interface will prompt you to activate WHMCS. To do this, enter an existing WHMCS license key if you already have one, or follow the link to purchase a new license.
  10. After entering your license key, click Activate to validate and complete the process.

WHMCS is now installed and ready to use.

Post Installation Suggested Steps

After you complete installation, we recommend that you configure WHMCS in the following order:

  1. Perform the recommended Further Security Steps.
  2. Log in to the Admin Area and configure your general settings (Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings).
  3. Set up your payment gateways (Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payment Gateways).
  4. Set up your products and services (Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products and Services).
  5. Configure your domain pricing (Configuration () > System Settings > Domain Pricing or, prior to WHMCS 8.0, Setup > Domain Pricing).
  6. Set up your support ticket departments (Configuration () > System Settings > Support Departments or, prior to WHMCS 8.0, Setup > Support Departments).
  7. Set up email piping so you can manage tickets using the WHMCS Support Desk. For more information, see Email Piping.
  8. Make sure that the WHMCS cron job is set up and configure automated tasks (Configuration () > System Settings > Automation Settings or, prior to WHMCS 8.0, Setup > Automation Settings).
  9. Place some test orders on your website to check your setup.

Watch the video tutorial for this feature  

For further guidance, watch our video tutorials: https://youtube.com/whmcs