Revision as of 23:37, 29 January 2020

WHMCS has many features built-in to help keep your data safe, but here are several simple extra steps you can take to secure your WHMCS installation even further.

Secure the Writeable Directories

We recommend moving all writeable directories to a non-public location to prevent web based access. There are three writeable directories required for WHMCS to function, they are: attachments, downloads and templates_c

WHMCS needs to be given the new location of the writeable directories. This is done in two places:

File Storage

The attachments and downloads storage directories can be moved to a local location or stored remotely on an AWS S3-compatible service. If you are unfamiliar with the AWS S3 service we recommend using the local storage option.

1. Create the storage location. This could be either:
   • A writeable directory on your server above the web-root
   • A non-public AWS S3-compatible storage bucket.
2. Navigate to Setup > Storage Settings
3. Use the interface to add the secure storage locations and switch to them.

For step-by-step guidance using this interface please refer to Storage Settings.

Templates Cache

The templates cache (templates_c) is used to improve performance of templated pages and emails.

1. Create a templates_c directory in the desired location (a non-public location above your web root)
2. Edit the configuration.php file and specify the path to the new location by adding a new line:

$templates_compiledir = "/home/username/templates_c/";

In the above example, "username" is the cPanel username and so the folder is located in the home directory, above public_html.

Secure the `configuration.php` File

We recommend adjusting the permissions set for the "configuration.php" file located in your WHMCS root directory. This file contains sensitive data that cannot be recovered without a backup of the file. To avoid accidentally overwriting, editing or deleting the file, change the permission setting of this file to `400`. This provides read only access to the file by the system and prevents anyone else from reading, editing or executing the file.

To change the permissions on this file, you can run the following command from shell while in your WHMCS root directory:

chmod 400 configuration.php

Move the Crons Directory

By default, the system stores cron-related items in the /crons/ directory. We recommend moving the crons directory to a custom private directory above your web root. This will prevent web-based access and help to protect your WHMCS installation.

Moving the Crons Directory

When you customize this location, you must move the directory and update WHMCS's configuration.

For steps to do this, see Moving the Crons Directory.

Upgrades and Patches

Applying updates or patches after customizing your crons directory location requires an additional step. You must upload any updated crons files from the default location to your custom directory.

If you do not move the files, you will see errors and issues with WHMCS's automation.

Restrict Access by IP

For increased protection, if your staff use fixed IP addresses, you can add even more protection to your admin area by restricting access to a specific set of IPs. This is done by creating a file with the name .htaccess within your WHMCS admin directory, with the following content:

order deny,allow
allow from 12.34.5.67
allow from 98.76.54.32
deny from all

You can specify as many different allow from lines as you require. Or you can even allow entire IP subnet's by specifying just the first part of an IP, for example: "12.34.". This is called Htaccess IP Restriction.

Change your WHMCS Admin Folder Name

Customising the url of your WHMCS admin area makes it harder for bots and malicious users to find it. It is not required, but if you wish to do so, find out how here: Customising the Admin Directory

Restrict Database Privileges

For day to day use, only the following database privileges are required. All others may be disabled.

• DELETE
• INSERT
• SELECT
• UPDATE
• LOCK TABLES

Please note that installation, upgrading, activating, and deactivating modules require the following additional privileges.

• ALTER
• CREATE
• DROP
• INDEX

Enable SSL

As a billing application that handles customer data, there is often private and sensitive data passing between it and end users browsers. Therefore having a valid SSL Certificate that enables the use of HTTPs and encrypted communication is essential.

Once you have an SSL Certificate configured, simply enter the https:// enabled URL in the WHMCS System URL field in Setup > General Settings to ensure it is used.

If you do not have an SSL Certificate, you may purchase one quickly and easily at: https://www.whmcs.com/ssl-certificates/

Vendor Directory

WHMCS is distributed with a vendor directory ("/vendor"). This is a common directory for advanced scripts and applications, such as WHMCS, and is comprised of various common libraries. However, web servers should not serve file requests directly from this path. Only the controlling script or application should load these libraries in order to ensure appropriate context and prevent unexpected behavior.

Apache is the recommended web server software platform on which to run WHMCS. If you are using Apache, the .htaccess distributed by WHMCS in the /vendor directory should suffice. If you are running Apache and files remain accessible, then you will want to investigate if your Apache configuration has disabled the use of .htaccess files or if there is a parent configuration that is negating the directive in the provided .htaccess file.

While other web server technologies are not officially supported, we understand that some users do wish to run WHMCS in environments other than Apache. For those that do, you must ensure that files within the /vendor directory are not served based on your web server configuration.

If you are using NGINX as your web server, we have put together a general guideline to assist you and your system administrator here: https://docs.whmcs.com/Nginx_Directory_Access_Restriction

<< Back to Installation Overview