Difference between revisions of "Getting Started"

From WHMCS Documentation

(Buying a licence)
Line 1: Line 1:
This guide covers the basics of WHMCS; starting with ordering a licence, downloading the software, installing it and then what to do next. This page aims to provide a brief overview and will signpost you to the relevant sections in our documentation for full details on everything covered.
+
This guide covers the basics of WHMCS starting with ordering a licence, downloading the software, installing it, and getting started using it.  
  
==Buying a licence==
+
==Buying a Licence==
  
 
First, buy a licence for the WHMCS software. To do this, click [http://www.whmcs.com/order-now/ Order Now]. We offer a range of licence options to suit all budgets. You can switch between tiers at any time.
 
First, buy a licence for the WHMCS software. To do this, click [http://www.whmcs.com/order-now/ Order Now]. We offer a range of licence options to suit all budgets. You can switch between tiers at any time.
  
 
We offer many great addons to increase the value of WHMCS, from a fully-integrated live chat solution to a mobile phone app to a full project management system. To see all of these options, see our [http://www.whmcs.com/addons/ Addons] list.
 
We offer many great addons to increase the value of WHMCS, from a fully-integrated live chat solution to a mobile phone app to a full project management system. To see all of these options, see our [http://www.whmcs.com/addons/ Addons] list.
 
 
  
 
  Buy a license https://www.whmcs.com/pricing
 
  Buy a license https://www.whmcs.com/pricing
  
==Downloading the software==
+
==Downloading the Software==
  
 
<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>
 
<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>
  
Once a licence has been purchased, the software can be downloaded from our [https://www.whmcs.com/members/ Members Area]:[[File:Download.png|thumb|File Download Page]]
+
After you purchase a license, download WHMCS from the [https://www.whmcs.com/members/ WHMCS Members Area]:[[File:Download.png|thumb|File Download Page]]
#Click the ''My Licenses'' link under the '''Services''' menu
+
#Select '''My Licenses''' in the '''Services''' menu.
 
#Select one of your active license keys to view the details
 
#Select one of your active license keys to view the details
#Click the blue ''Download Now'' button to download the latest stable release.
+
#Click '''Download Now''' to download the latest stable release. If you chose to purchase any addons that require extra files, their downloads will also appear here.
##If you chose to purchase any addons which require extra files, their downloads will also appear here. Note: Not all our addons require extra files.
+
#Save the ZIP file to your computer.
#Save the zip file to your computer.
 
 
 
 
 
  
 
  Download the software: https://www.whmcs.com/members/
 
  Download the software: https://www.whmcs.com/members/
Line 30: Line 25:
 
<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>
 
<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>
  
Next the WHMCS software must be installed on your server. Please check with your server admin/hosting provider that your server meets the [[System Requirements]].
+
Next, install WHMCS on your serve, making sure that your server meets the [[System Requirements]]. You may need to consult your system administrator or hosting provider to confirm this.
  
Installing WHMCS is as simple as installing many other web-based scripts (WordPress®, Joomla, phpBB, etc.). This is a very brief overview of the installation process. More [[Installing_WHMCS|detailed installation instructions]] are available.
+
The installation process is easy, and typically follows this process:
 
[[File:Installing.png|thumb|Installing WHMCS]]
 
[[File:Installing.png|thumb|Installing WHMCS]]
#Upload the WHMCS zip file to your server
+
#Upload the WHMCS ZIP file to your server.
#Extract the zip file and move the WHMCS files your desired location (popular directory names include members, clients, secure or billing)
+
#Extract the ZIP file.
#Create a new MySQL Database and assign a database user to it.
+
#Move the extracted WHMCS files your desired directory location. Popular directory names include <tt>members</tt>, <tt>clients</tt>, <tt>secure</tt>, or <tt>billing</tt>.
#Visit the installation script at /install/install.php and to run the installer process.
+
#Create a new MySQL® database and assigned database user.
#Follow the on-screen instructions to complete the installation process.
+
#Go to the installation script at <tt>/install/install.php</tt> and run the installer process.
#When complete, delete the install folder from your web server and CHMOD the configuration.php file back to 644.
+
#Follow the onscreen instructions.
 +
#When the process is complete:
 +
##Delete the <tt>install</tt> directory from your server.
 +
##Use the <tt>chmod</tt> command to set the <tt>configuration.php</tt> file's permissions to <tt>644</tt>.
 
<br/>
 
<br/>
 
  Detailed installation instructions: [[Installing WHMCS]]
 
  Detailed installation instructions: [[Installing WHMCS]]
Line 45: Line 43:
  
 
==Further Security Steps==
 
==Further Security Steps==
The WHMCS software will contain some sensitive data, and whilst security is always our number one priority, it is sensible to take extra precautions to ensure your server and the software installed upon it is as secure as possible. To that end, we have some suggestions for further securing a WHMCS installation at [[Further Security Steps]].
+
WHMCS will contain sensitive data. Take extra precautions to ensure your server and its software are secure.
  
 
   Detailed Further Security Steps: [[Further Security Steps]]
 
   Detailed Further Security Steps: [[Further Security Steps]]
Line 54: Line 52:
  
 
[[File:Admin summary.png|thumb|Admin Summary Page]]
 
[[File:Admin summary.png|thumb|Admin Summary Page]]
Now the software is fully installed and secured you can start getting things configured. All the set up, configuration and day-to-day administration is done through the administration area. To login, visit the URL at which you installed the software, for example https://www.example.com/whmcs/admin using the username and password created during the installation process.
 
  
Upon login you will be see the Admin Summary page; this page provides an overview of all your company operations. At the top of the page are the Income statistics and the Attention Items - these are items requiring your action. The summary page is made up of "Widgets", each staff member can arrange them however they like simply by clicking and dragging. They can be closed by clicking the "-" icon and disabled entirely in the Administrator Role.
+
After installation, you can begin configuring WHMCS through the WHMCS Admin Area. To log in and get started, visit the URL at which you installed the software (for example, <tt>https://www.example.com/whmcs/admin</tt>) using the username and password you created during the installation process.
 +
 
 +
When you log in, you will immediately see the Admin Area Dashboard, from which you can access all of the needed tools and settings.
  
 
  Administration Area Documentation: [[Admin Area]]
 
  Administration Area Documentation: [[Admin Area]]
Line 65: Line 64:
 
<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Configuration Service:</b> Have our team configure WHMCS for you.</small></em><span class="button">Services</span></a></html>
 
<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Configuration Service:</b> Have our team configure WHMCS for you.</small></em><span class="button">Services</span></a></html>
  
After installation is completed, we recommend that you go through and configure your new WHMCS system in the following order:
+
After installation, we recommend that you configure WHMCS in the following order:
  
#Log in to the Admin Area and configure '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Configuration|General Settings]]'''.
+
#Log in to the Admin Area.
 +
#Configure the settings at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Configuration|General Settings]]'''.
 
#Set up your Payment Gateways in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]'''.
 
#Set up your Payment Gateways in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]'''.
 
#Add your servers to WHMCS in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > [[Servers]]'''.
 
#Add your servers to WHMCS in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > [[Servers]]'''.
Line 74: Line 74:
 
#Configure your Domain Pricing in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domains_Configuration|Domain Pricing]]'''.
 
#Configure your Domain Pricing in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domains_Configuration|Domain Pricing]]'''.
 
#Set up your Support Ticket Departments in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support_Center|Support Departments]]'''.
 
#Set up your Support Ticket Departments in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support_Center|Support Departments]]'''.
#Set up email piping so you can manage tickets using the WHMCS Support Desk. For full instructions on this, see [[Email Piping]].
+
#Set up support ticket replies via email. For steps, see [[Email Piping]].
#Ensure the WHMCS Cron Job is set up and configure automated tasks in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]'''.
+
#Ensure that the WHMCS Cron Job is set up and configure the related automated tasks in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]'''.
#Place some test orders on your website to check everything works as expected.
+
#Place some test orders on your website to ensure WHMCS is working as expected.
  
 
<html><a href="https://www.youtube.com/playlist?list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb" class="docs-video-tutorial"><em>Watch the video tutorial for this feature.</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>
 
<html><a href="https://www.youtube.com/playlist?list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb" class="docs-video-tutorial"><em>Watch the video tutorial for this feature.</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>
  
For further guidance, you can watch video tutorials we have prepared for the above tasks at [https://www.youtube.com/playlist?list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb youtube.com/whmcs].
+
For more information, see [https://www.youtube.com/playlist?list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb youtube.com/whmcs].
  
 
  Detailed Configuration Instructions: [[Setup/Configuration]]
 
  Detailed Configuration Instructions: [[Setup/Configuration]]
Line 87: Line 87:
 
Click '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>)''' or, prior to WHMCS 8.0, '''Setup''' to view the Setup Tasks Checklist, this itemizes the recommended configuration steps to make the most of WHMCS.
 
Click '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>)''' or, prior to WHMCS 8.0, '''Setup''' to view the Setup Tasks Checklist, this itemizes the recommended configuration steps to make the most of WHMCS.
  
You may already have some clients and wish to start managing them through WHMCS, they'll need to be imported. For instructions doing so, refer to the [[Importing Data]] page.
+
You may already have some clients and wish to start managing them through WHMCS. If so, they'll need to be imported. For instructions, see [[Importing Data]].
  
Make sure you are up-to-date with all the latest fixes, updates and features introduced in your version of WHMCS by reading the [[Release Notes]].
+
Make sure you are up-to-date with all the latest fixes, updates, and features in your version of WHMCS by reading the [[Release Notes]].
  
 
We use a licensing system to ensure that only those who have paid for the software may use it. Learn more about this works and what you need to do if you wish to move your WHMCS installation on the [[Licensing]] page.
 
We use a licensing system to ensure that only those who have paid for the software may use it. Learn more about this works and what you need to do if you wish to move your WHMCS installation on the [[Licensing]] page.

Revision as of 17:08, 20 July 2021

This guide covers the basics of WHMCS starting with ordering a licence, downloading the software, installing it, and getting started using it.

Buying a Licence

First, buy a licence for the WHMCS software. To do this, click Order Now. We offer a range of licence options to suit all budgets. You can switch between tiers at any time.

We offer many great addons to increase the value of WHMCS, from a fully-integrated live chat solution to a mobile phone app to a full project management system. To see all of these options, see our Addons list.

Buy a license https://www.whmcs.com/pricing

Downloading the Software

Watch the video tutorial for this feature  

After you purchase a license, download WHMCS from the WHMCS Members Area:
File Download Page
  1. Select My Licenses in the Services menu.
  2. Select one of your active license keys to view the details
  3. Click Download Now to download the latest stable release. If you chose to purchase any addons that require extra files, their downloads will also appear here.
  4. Save the ZIP file to your computer.
Download the software: https://www.whmcs.com/members/

Installing the software

Watch the video tutorial for this feature  

Next, install WHMCS on your serve, making sure that your server meets the System Requirements. You may need to consult your system administrator or hosting provider to confirm this.

The installation process is easy, and typically follows this process:

Installing WHMCS
  1. Upload the WHMCS ZIP file to your server.
  2. Extract the ZIP file.
  3. Move the extracted WHMCS files your desired directory location. Popular directory names include members, clients, secure, or billing.
  4. Create a new MySQL® database and assigned database user.
  5. Go to the installation script at /install/install.php and run the installer process.
  6. Follow the onscreen instructions.
  7. When the process is complete:
    1. Delete the install directory from your server.
    2. Use the chmod command to set the configuration.php file's permissions to 644.


Detailed installation instructions: Installing WHMCS

Need help with installation? Check our available services.Services

Further Security Steps

WHMCS will contain sensitive data. Take extra precautions to ensure your server and its software are secure.

 Detailed Further Security Steps: Further Security Steps


First Login

Watch the video tutorial for this feature  

Admin Summary Page

After installation, you can begin configuring WHMCS through the WHMCS Admin Area. To log in and get started, visit the URL at which you installed the software (for example, https://www.example.com/whmcs/admin) using the username and password you created during the installation process.

When you log in, you will immediately see the Admin Area Dashboard, from which you can access all of the needed tools and settings.

Administration Area Documentation: Admin Area


Configuring WHMCS

Configuration Service: Have our team configure WHMCS for you.Services

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

  1. Log in to the Admin Area.
  2. Configure the settings at Configuration () > System Settings > General Settings.
  3. Set up your Payment Gateways in Configuration () > System Settings > Payment Gateways.
  4. Add your servers to WHMCS in Configuration () > System Settings > Products/Services > Servers.
  5. Set up your products and services in Configuration () > System Settings > Products/Services > Products/Services.
  6. Enter your domain registrar account details in Configuration () > System Settings > Products/Services > Domain Registrars.
  7. Configure your Domain Pricing in Configuration () > System Settings > Domain Pricing.
  8. Set up your Support Ticket Departments in Configuration () > System Settings > Support Departments.
  9. Set up support ticket replies via email. For steps, see Email Piping.
  10. Ensure that the WHMCS Cron Job is set up and configure the related automated tasks in Configuration () > System Settings > Automation Settings.
  11. Place some test orders on your website to ensure WHMCS is working as expected.

Watch the video tutorial for this feature.  

For more information, see youtube.com/whmcs.

Detailed Configuration Instructions: Setup/Configuration

What's Next

Click Configuration () or, prior to WHMCS 8.0, Setup to view the Setup Tasks Checklist, this itemizes the recommended configuration steps to make the most of WHMCS.

You may already have some clients and wish to start managing them through WHMCS. If so, they'll need to be imported. For instructions, see Importing Data.

Make sure you are up-to-date with all the latest fixes, updates, and features in your version of WHMCS by reading the Release Notes.

We use a licensing system to ensure that only those who have paid for the software may use it. Learn more about this works and what you need to do if you wish to move your WHMCS installation on the Licensing page.

Learn to use WHMCS: Using WHMCS and Howtos

Where do I get help?

Documentation

Docs.gif

Our documentation is comprehensive and covers every aspect of the WHMCS software. If you're unsure about any of the options on a given page simply click the yellow "Help" link in the top-right corner to be taken directly to the relevant section. You can also search the documentation using the Search box in the top-right corner of this page. Some useful sections are:

Help Guides

Guides.png

A range of self-help guides are available at help.whmcs.com assist with many common tasks in the WHMCS software, including Setup and Configuration, guiding you through the System Settings and Payments & Currency.

There is also an extensive troubleshooting section should you encounter any problems.

Video Tutorials

Tutorials.gif

These Youtube video tutorials provide a visual step by step walk-through of all the common setup and configuration tasks you’ll need to perform when getting started with WHMCS. We recommend watching these before configuring the software.

Community

Community.gif

Our Community is home to a very active community of experienced WHMCS users that are always willing to help and discuss new ideas. These forums are primarily a place for discussion between customers and so you should not expect to receive a response from staff here.

Support Ticket

Submitticket.gif

You should submit a support ticket when you are unable to find answers to your questions using any of the above resources. If you have a monthly license you are entitled to support at any time but if on an owned license, you may be required to renew your support and upgrades before help can be provided.

Getting Help: https://www.whmcs.com/support/