Difference between revisions of "Documentation Home"
Line 1: | Line 1: | ||
− | Welcome to the WHMCS Documentation. This is your one stop resource for everything WHMCS - from initial setup, to | + | Welcome to the WHMCS Documentation. This is your one stop resource for everything WHMCS - convering everything from initial setup, to advanced customisation and API integration. If it's not here, it doesn't exist. |
− | + | '''To begin your search, what topic can we help you with today?''' | |
− | |||
− | ==Getting Started== | + | <html> |
+ | <script> | ||
+ | function selectCat(name) { | ||
+ | $("#"+name).slideToggle(); | ||
+ | } | ||
+ | </script> | ||
+ | |||
+ | <div style="width:90%;margin:0 auto;"> | ||
+ | <div style="float:left;width:50%;"> | ||
+ | |||
+ | <div style="float:left;"><img src="http://www.whmcs.com/images/icons/css.png" align="top" /></div> | ||
+ | <div class="docshomecat"><a href="#" onclick="selectCat('gettingstarted');return false">Getting Started</a></div> | ||
+ | <div class="docshomecatclear"></div> | ||
+ | <div class="docshomecatlinks" id="gettingstarted"> | ||
+ | </html> | ||
{{:Getting Started}} | {{:Getting Started}} | ||
+ | <html> | ||
+ | </div> | ||
− | == | + | <div style="float:left;"><img src="http://www.whmcs.com/images/icons/paint.png" align="top" /></div> |
+ | <div class="docshomecat"><a href="#" onclick="selectCat('customisation');return false">Customisation</a></div> | ||
+ | <div class="docshomecatclear"></div> | ||
+ | <div class="docshomecatlinks" id="customisation"> | ||
+ | </html> | ||
{{:Customising WHMCS}} | {{:Customising WHMCS}} | ||
+ | <html> | ||
+ | </div> | ||
+ | |||
+ | <div style="float:left;"><img src="http://www.whmcs.com/images/icons/config.png" align="top" /></div> | ||
+ | <div class="docshomecat"><a href="#" onclick="selectCat('config');return false">Setup/Configuration</a></div> | ||
+ | <div class="docshomecatclear"></div> | ||
+ | <div class="docshomecatlinks" id="config"> | ||
+ | </html> | ||
+ | {{:Setup/Configuration}} | ||
+ | <html> | ||
+ | </div> | ||
− | ==Modules== | + | </div> |
+ | <div style="float:left;width:50%;"> | ||
+ | |||
+ | <div style="float:left;"><img src="http://www.whmcs.com/images/icons/docs.png" align="top" /></div> | ||
+ | <div class="docshomecat"><a href="#" onclick="selectCat('generalusage');return false">General Usage</a></div> | ||
+ | <div class="docshomecatclear"></div> | ||
+ | <div class="docshomecatlinks" id="generalusage"> | ||
+ | </html> | ||
+ | {{:Using WHMCS and Howtos}} | ||
+ | <html> | ||
+ | </div> | ||
+ | |||
+ | <div style="float:left;"><img src="http://www.whmcs.com/images/icons/addonmodules.png" align="top" /></div> | ||
+ | <div class="docshomecat"><a href="#" onclick="selectCat('modules');return false">Modules</a></div> | ||
+ | <div class="docshomecatclear"></div> | ||
+ | <div class="docshomecatlinks" id="modules"> | ||
+ | </html> | ||
{{:Modules}} | {{:Modules}} | ||
+ | <html> | ||
+ | </div> | ||
− | ==API== | + | <div style="float:left;"><img src="http://www.whmcs.com/images/icons/logging.png" align="top" /></div> |
− | + | <div class="docshomecat"><a href="#" onclick="selectCat('developers');return false">Developers/API</a></div> | |
− | + | <div class="docshomecatclear"></div> | |
− | + | <div class="docshomecatlinks" id="developers"> | |
+ | </html> | ||
+ | {{:Customising WHMCS}} | ||
+ | <html> | ||
+ | </div> | ||
− | </ | + | </div> |
+ | <div class="clear"></div> | ||
+ | </div> | ||
+ | </html> | ||
− | + | '''Hot Topics:''' [[Troubleshooting Guide]], [[Installing WHMCS]], [[Upgrading]], [[CPanel/WHM]], [[Developer Resources]] | |
− | |||
− | + | '''Useful Links:''' [http://forum.whmcs.com/ Community Forums], [http://blog.whmcs.com/ Blog], [http://www.whmcs.com/members/communityaddons.php App Store], [http://www.whmcs.com/members/downloads.php?action=displaycat&catid=2 Import Scripts], [http://www.whmcs.com/demo.php Demo/Test Area], [http://www.whmcs.com/services.php Services], [https://www.whmcs.com/members Client Area] | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | < | + | <div style="text-align:center;font-size:11px;">[[Contents|Full Contents Page]]</div> |
__NOTOC__ | __NOTOC__ |
Revision as of 23:08, 23 March 2012
Welcome to the WHMCS Documentation. This is your one stop resource for everything WHMCS - convering everything from initial setup, to advanced customisation and API integration. If it's not here, it doesn't exist.
To begin your search, what topic can we help you with today?
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:
- Select My Licenses in the Services menu.
- Select one of your active license keys to view the details
- 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.
- 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 server, making sure that your server meets the System Requirements.
- You can use several different methods to do this.
- Depending on your server access level, you may need to consult your system administrator or hosting provider for assistance.
Detailed installation instructions: Installing WHMCS and Install On The Command Line
Need help with installation? Check our available services.
Further Security Steps
Your WHMCS installation will contain sensitive data. We recommend taking extra precautions to ensure your server and its software are secure.
Steps to secure your server: Installing WHMCS and Securing Your Installation
First Login
Watch the video tutorial for this feature
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.
After you complete installation, we recommend that you configure WHMCS in the following order:
- Perform the recommended Further Security Steps.
- Configure your general settings (Configuration () > System Settings > General Settings).
- Set up your payment gateways (Configuration () > Apps & Integrations).
- Set up your products and services (Configuration () > System Settings > Products/Services).
- Configure your domain pricing (Configuration () > System Settings > Domain Pricing).
- Set up your support ticket departments (Configuration () > System Settings > Support Departments).
- Set up email piping to manage tickets using the WHMCS Support Desk.
- Create and configure the WHMCS cron job and its automated tasks (Configuration () > System Settings > Automation Settings).
- Place some test orders on your website to check your setup.
For help, watch video tutorials.
Detailed Configuration Instructions: Setup/Configuration
What's Next
The Setup Tasks checklist itemizes the recommended configuration steps to make the most of WHMCS. In WHMCS 8.5 and later, you can see this list at Configuration () > System Settings when you click Click here to view the setup tasks.
- In WHMCS 8.0 through 8.4, go to Configuration () > System Settings.
- Prior to WHMCS 8.0, go to Setup.
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
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
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
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
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
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/
- Linking to WHMCS
- Developer Resources
- Template Syntax
- Client Area Template Files
- Admin Area Customisation
- Order Form Templates
- PDF Invoice
- Creating Pages
- Language Files
- Data Feeds
- Creating Modules
- Action Hooks
- Widgets
- WHMCS Insights Blog
- WHMCS Guest Blog
General
- General Settings
- Sign-In Integrations
- Automation Settings
- MarketConnect
- Administrators and Permissions
- Two-Factor Authentication
- Application Links
- Email Templates
- Client Groups
- Custom Fields
- Fraud Protection
- Order Statuses
- Security Questions
Payments
- Currencies
- Payment Gateways
- Tax/VAT Rules
- Promotions
- Invoicing Setup
- Send PDF Invoices and Receipts
- Set Up Recurring Billing
- Payment Reminders
- Financial reporting and analytics
Products/Services
- Configuring Products/Services
- Configurable Options
- Product Addons
- Product Bundles
- Domain Pricing
- Domain Registrars
- Servers
Support
- Support Tickets
- Ticket Statuses
- Escalation Rules
- Email Piping
- Spam Control
- Knowledgebase & Downloads
- Announcements
- Network Issues
System
- Automatic Backups
- IP/Email Ban Control
- Database Backups
- Storage Settings
- Sessions
- Maximising Performance
- Changing Timezone
- Maintenance
- Cookies
Core
- Client Management
- Order Management
- Products Management
- Domains Management
- Order Forms
- Upgrades/Downgrades
- Admin Area
Billing
Support
Other
Hot Topics: Troubleshooting Guide, Installing WHMCS, Upgrading, CPanel/WHM, Developer Resources
Useful Links: Community Forums, Blog, App Store, Import Scripts, Demo/Test Area, Services, Client Area