WHMCS Documentation - User contributions [en]

Version 8.0.0 Release Notes

2020-08-04T12:49:09Z

Artem: /* New Documentation */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.0<br />
Release Type: Beta<br />
Release Date: 4th Aug 2020<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.0.0</td><td>Beta 1</td><td>4th Aug 2020</td></tr>
</table>

==Download==
Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==
WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

You will only see the WHMCS 8.0 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8.0 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.

Once you are running WHMCS 8.0, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===
If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, please refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== Users and Client Accounts ===
WHMCS now supports accounts and users in a new end-user login management system. Accounts own services for a given entity. A single user can then manage multiple accounts.

[[Users_And_Accounts|Learn more...]]

=== New Admin Area Look ===
Admin Area Blend theme enhancements bring an updated look and better performance to the Admin Area. We've also added improved support for mobile devices and tablets.

=== Mail Deliverability Providers ===
Admin users can now easily configure email sending from one of several new mail providers. Currently, this includes SparkPost, SendGrid, and Mailgun. Using them enhances your email deliverability and security.

[[Mail_Providers|Learn more...]]

=== Email Campaigns ===
The new '''Email Campaigns''' tool has replaced the '''Mass Mail Tool'''. The new features include scheduling and saving drafts of your email campaigns, and adding styling.

[[Email_Campaigns|Learn more...]]

=== Improved IDN Support ===
Sell a broader range of domain names with full International Domain Name support. Enom and ResellerClub support automatic IDN registration, and you'll benefit from robust IDN validation and usability improvements.

[[Domains_Tab|Learn more...]]

=== OAuth2 for SMTP ===
To facilitate moving away from password-based authentication, OAuth2 is now fully supported. Google is already available, and we plan to add more providers in the future.

[[Mail_Providers|Learn more...]]

=== Improved Currency Support ===
WHMCS now supports up to three decimal places in tax rates and currency values up to 99 trillion.

== Deprecation and Removal Notices ==

=== Removed Legacy PHP Support ===
Product support for the legacy PHP 5.6, 7.0, and 7.1 environments is removed. To install or upgrade, you must run PHP 7.2 or higher.

=== Removed PHP Extensions Requirement ===
The <tt>IMAP</tt> extension is no longer required.
The <tt>GD</tt> extension is no longer required for '''some''' features, but is still required for WHMCS as a whole.

=== Deprecated v4 Theme ===
The v4 theme for the Admin Area is deprecated. If no admin accounts currently use this theme, upgrading will '''delete''' it. If the theme is in use, it will remain available for selection. However, admins who are assigned to this theme will move to Blend when you upgrade.

=== Deprecated AutoAuth ===
AutoAuth was [announced](release_note_link) as deprecated in WHMCS version 7.10, including an option to enable or disable the feature. When you upgrade, the feature is disabled regardless of its previous value. We will remove AutoAuth in WHMCS version 8.1.

[[https://www.php.net/manual/en/migration72.php|Learn more...]]

=== Removed Boxes and Modern Templates ===
The ''Boxes'' and ''Modern'' templates have been removed.

If products or groups use one of these, upgrading selects a new template that emulates the deprecated template. The system assigns the new template to everything that previously used the deprecated template. Newly-created child templates are based on the ''Standard'' template.

This upgrade will not touch custom themes.

=== Removed Modules ===
We have removed the PayMate.eu, PayMate.nz, GameCP, and Kayako LoginShare modules.

=== Removed Legacy Files ===
We have removed <tt>whois.php</tt> from the Client Area file set.
The <tt>pipe</tt> directory was deprecated and has been removed. Use <tt>crons/pipe.php</tt> instead.

== Library Updates ==

The following libraries have been updated or removed:

=== PHP ===
* smarty/smarty: 3.1.33 to 3.1.36
* abraham/twitteroauth: 0.7.4 to 1.1.0
* bitpay/sdk-light: 1.2.2002 to 2.0.2007
* composer/composer: 1.10.5 to 1.10.6
* ezyang/htmlpurifier: 4.9.2 to 4.12.0
* filp/whoops: 2.1.8 to 2.7.2
* firebase/php-jwt: 3.0.0 to 5.2.0
* google/apiclient: v2.1.3 to 2.7.0
* google/auth: 0.9.0 to 1.11.0
* guzzlehttp/guzzle: 6.5.3 to 7.0.1
* illuminate/console: 7.9.2 to 7.12.0
* illuminate/container: 7.9.2 to 7.12.0
* illuminate/contracts: 7.9.2 to 7.12.0
* illuminate/database: 7.9.2 to 7.12.0
* illuminate/events: 7.9.2 to 7.12.0
* illuminate/support: 7.9.2 to 7.12.0
* illuminate/validation: 7.9.2 to 7.12.0
* knplabs/knp-menu: 2.1.1 to 3.1.1
* league/climate: 3.2.1 to 3.5.2
* league/flysystem: 1.0.45 to 1.0.67
* league/oauth2-client: 2.4.1 to 2.5.0
* league/oauth2-google: 2.5.0 to 3.0.3
* monolog/monolog: 1.18.2 to 2.0.2
* nikic/fast-route: 1.2.0 to 1.3.0
* php-imap/php-imap: 2.0.9 to 3.1.0
* phpmyadmin/sql-parser: 4.2.4 to 5.3.1
* phpmyadmin/phpmailer: 6.0.7 to 6.1.5
* phpseclib/mcrypt_compat: 1.0.5 to 1.0.11
* phpseclib/phpseclib: 2.0.10 to 2.0.27
* punic/punic: 1.6.3 to 3.5.1
* ramsey/uuid: 3.4.1 to 4.0.1
* react/promise: 2.5.1 to 2.8.0
* seld/jsonlint: 1.6.1 to 1.8.0
* seld/phar-utils: 1.0.1 to 1.1.0
* stripe/stripe-php: 6.43.1 to 7.34.0
* symfony/polyfill-iconv: 1.15.0 to 1.17.0
* symfony/polyfill-mbstring: 1.14.0 to 1.17.0
* tecnickcom/tcpdf: 6.2.26 to 6.3.5
* zendframework/zend-diactoros: Removed.

== New Documentation ==
The following new documentation pages are available:
* [[Email Campaigns]]
* [[Mail Providers]]
* [[Configuring Mail Providers]]
* [[Users And Accounts]]
* [[Email Sending Issues]] (Updated)
* [[Sign-In Integrations]] (Updated)
* [[Product Groups]] (Updated)
* [[Products and Services]] (Updated)
* [https://developers.whmcs.com/mail-providers/ Mail Providers Developer Documentation]
* [https://developers.whmcs.com/domain-registrars/module-parameters/ Domain Registrars Developer Documentation] (Updated)
* [https://developers.whmcs.com/api-reference/getticket/ GetTicket Developer Documentation] (Updated)
* [https://developers.whmcs.com/api-reference/gettickets/ GetTickets Developer Documentation] (Updated)

=== Template ===
The following link provides a comparison of changes between 7.10.2 and 8.0:
[[LINK]]

== Changelog ==
* [[Changelog:WHMCS_V8.0.0_Beta_1|Version 8.0.0 Beta 1]]

Users and Accounts

2020-08-04T12:42:37Z

Artem: /* Invitations */

WHMCS 8.0 and later introduced a new user management system. It allows a single user access to multiple client accounts. It clearly separates authentication and authorization from services, billing, and support.

Admins can view information about individual accounts and their associated users. For more information, see [[Client Management]] and [[Clients:Users_Tab|Users]].

==Accounts and Users==
Accounts (formerly "clients") own products and services. They represent a billable party, like a business.

Users have with one or more associated accounts that they can access and manage. Whenever a new account is created, a new user is created based on the account profile and becomes the account owner (see below). Separate controls manage users' access to each account.

For example, each of a web designer's customers could represent a distinct account. The web designer could log in and access each of these accounts using a single set of credentials. However, the accounts themselves would not be connected.

===Account Owners===
Each account is associated with a single account owner. Account owners have all of the possible permissions that a user can possess. They are also the only user who can send invitations from the account to other new or existing users.

During checkout, authenticated users can choose to create a new account for the items in the cart. In this case, the system will assign account ownership for the new account to that user.

==Account and User Management==
Accounts (and associated users) can manage users and their permissions from the '''User Management''' section of the Client Area. For more information, see [https://help.whmcs.com/m/managing/l/1275668-adding-and-managing-users Adding and Managing Users].

Admins can also manage them from the '''[[Clients:Users_Tab|Users]]''' tab in the client profile in the Admin Area. Account ownership can only be transferred between users through the Admin Area.

Users can also be removed via these two interfaces.

===Invitations===
To connect a user to multiple accounts, send an invitation from each account to that user or email address at any time. The invitee will receive an email and must click the included link and log in or create an account.

<div class="docs-alert-warning">
<span class="title">Note</span><br />
Invitations expire after 7 days.
</div>

Accounts (and users controlling them) can send invitations from the '''User Management''' section of the Client Area. Admins can also send them from the '''Users''' tab in the client profile in the Admin Area. The invitations can go to new or existing users and accounts.

For steps to send invitations, see [[Clients:Users_Tab|Users]] and [https://help.whmcs.com/m/managing/l/1275668-adding-and-managing-users Adding and Managing Users].

==Upgrading to WHMCS 8.0==
On upgrade to WHMCS 8.0, no action is necessary to maintain the current configuration. (You must perform several steps when you choose to connect users and accounts.) Contacts will remain associated with each account. Sub-Accounts will become user accounts that can access their associated account. The primary client account will also become a user.

Knowledgebase

2020-03-12T14:33:48Z

Artem: /* Image Uploading */

The knowledgebase feature allows you to create a collection of commonly asked questions and their answers.

Articles can be grouped into categories, and categories can be either public or hidden, allowing you to create staff only knowledgebase entries too.

The client area offers the user the choice of browsing through the articles in your KB by category, popular tags or searching based on keywords they enter.

===Creating Categories & Articles===

* The first step is to create a category to contain articles, navigate to '''Support > Knowledgebase''' and click the Add Category tab
* Enter a name and description to be displayed to clients. Tick the Hide checkbox to make this category invisible, it will only be visible in the admin area. Click Add Category.
* Now click the Add Article tab and enter the title of the first article and click Add Article to be taken to the editing page.
* The Category field displays which categories this article belongs to, a single article can be assigned to multiple categories by ctrl + clicking.
* The views and votes statistics can be changed here, it displays how many people have viewed this article and how many rated it helpful.
* Ticking the Private checkbox will mean this article is not visible to visitors so clients must be logged in to read it.
* The Display Order enables the default alphanumeric display order (1,2,3,a,b,c...) to be overridden with a custom one. An article with a display order value or 0 would be displayed at the top of the category, 1 beneath that, 2 beneath that and so on.
* Enter the contents of your article in the large text area.
* If you operate in multiple languages click the language beneath the main text area to reveal an additional text area into which the article can be translated.
* Finally click Save Changes

===Editing Articles===

To edit an existing article simply click the category name and then the article name.

===Tags===

Knowledge base tags are available to highlight keywords relating to an article.

Tags allow you to group articles across multiple categories that share a common theme. Tags are then used to generate a Tag Cloud showing the most common themes in articles and allowing all articles associated with a given tag to be viewed.

Tags that occur more frequently will display in a larger font providing an indication of the number of articles for a given tag.

====Managing Tags====

* Navigate to the article you wish to modify tags for
* Begin typing tags into the Tags field
** Any matching existing tags will be displayed, simply press the Enter key to add the selected tag
** To add a new tag, continue typing and once complete hit Space or Enter
** Tags may not contain spaces - you can however use hyphens

===Image Uploading===

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This section describes features available in version 7.10 and above</div>

Images can be uploaded through the knowledgebase rich text editor from the Insert → Image menu.

On the Insert/Edit image modal that appears, choose the Upload tab and follow the prompts. Once uploaded, the image URL will be inserted automatically a the point of the cursor.

After an image has been uploaded, it will be available for re-selection in the insert image popup under the '''Recent images''' select box. The Recent images select box will contain the last 25 uploaded images. This provides a faster and more convenient way to re-use the same images in translations or multiple articles.

==== Storage ====

Knowledgebase images use a Storage Setting to define where uploaded images are stored. On upgrade to WHMCS 7.10, or a new install of WHMCS, a default Storage Setting is used which can be checked and changed if required.

Storage Settings

2019-02-08T21:35:30Z

Artem:

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.7 and above</div>

Storage settings allow storing files outside of your WHMCS installation, reducing web space requirements. Prior to version 7.7, WHMCS only supported local storage. With version 7.7, we have introduced Amazon AWS S3 and compatible services for file storage needs.

==How it Works==

By default files will be stored locally within the WHMCS install. If you upgrade an existing WHMCS install to version 7.7 or later, any custom settings for attachments directory and/or downloads directory will be retained and any files will remain in their existing locations. However you may opt to migrate select file types to Amazon AWS S3 or a compatible service. WHMCS offers automatic migrations of your existing files to and from AWS S3, as well as between AWS S3 locations.

==Configuration==

To manage your storage settings, navigate to '''Setup > Storage Settings'''. Choose one of the following workflows depending on the desired use case.

===Local Storage===

You may desire to migrate files from an existing local storage location to another local directory. To do that:

#Click "Configuration" tab
#In "Add New Configuration" tile, choose "Local Storage" or and click "Add".
#Enter path to the new storage location. The directory must exist and be writable. Click "Save".
#Switch to "Settings" tab.
#Select the new storage location for the file type that you wish to migrate to the new location.
#Most file types can be migrated automatically, and you will be prompted to start migration by clicking "Migrate" button.
#*For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location.
#*If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location.
#* Former location will not be automatically cleaned - you may want to clean it manually once you validate that the migration was successful.
#You may choose to cancel an ongoing migration. The present location will then continue to be used. Files migrated to the new location until this point will not be deleted.
#Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file types storage setting at once. This will skip automatic migration and assumes your responsibility for moving the files to the new location.
#*If you elect this path, please note that certain file types may be stored by WHMCS in the same folder (for example, client files, email and ticket attachments as well as project management files will be stored in "attachments" folder). If you decide to move all the files away from that folder, all relevant file types must be switched to the new location.
#If you made a change by mistake, click "Revert Changes" to cancel any changes.

===AWS S3===
<div class="docs-alert-success">
A [https://help.whmcs.com/m/system/c/281650 step-by-step guide] demonstrating a basic S3 configuration is available in our [https://help.whmcs.com/m/system/c/281650 Guides & Tutorials section].
</div>

Once the storage bucket is configured, you may desire to migrate files to an AWS S3 bucket or a compatible service. With presumed familiarity of AWS S3, follow these steps:

#Click "Configuration" tab
#In "Add New Configuration" tile, choose "S3" or and click "Add".
#Enter AWS S3 connection details. S3 region must be specified as a code name, e.g. "us-east-1" for "US East (N. Virginia)"
#*To find the region code name for a bucket's region, [https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html click here] for a list of all available AWS regions and their code names.
#*The "Endpoint URL" is not required if using Amazon AWS S3 service - this field is only required if using a non-Amazon, S3-compatible storage provider.
#*The S3 access credentials must have read and write access to the specified S3 bucket. See below for an example of a suitable policy for the S3 user.
#Click "Save". If the bucket cannot be accessed, an error message will be shown.
#Switch to "Settings" tab.
#Select the new storage location for the file type that you wish to migrate to the new location.
#As with local storage, most file types can be migrated automatically, and you will be prompted to start migration by clicking "Migrate" button.
#*For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location.
#*If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location.
#*Former location will not be automatically cleaned - you may want to clean it manually once you validate that the migration was successful.
#You may choose to cancel an ongoing migration. The present location will then continue to be used. Files migrated to the new location until this point will not be deleted.
#Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file types storage setting at once. This will skip automatic migration and assumes your responsibility for moving the files to the new location.
#*If you elect this path, please note that certain file types may be stored by WHMCS in the same folder (for example, client files, email and ticket attachments as well as project management files will be stored in "attachments" folder). If you decide to move all the files away from that local folder, all relevant file types must be switched to the new location.
#If you made a change by mistake, click "Revert Changes" to cancel any changes.

====Example Security Policy====
Consider using the [https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html IAM Policy Generator tool] in the AWS control panel, or the [https://awspolicygen.s3.amazonaws.com/policygen.html public policy generator tool].
For power users, an example AWS S3 policy to be assigned to the S3 user for use with WHMCS storage settings is provided below:

{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "Stmt1111222223333",
"Effect": "Allow",
"Action": [
"s3:ListBucket",
"s3:GetObject",
"s3:GetObjectAcl",
"s3:PutObject",
"s3:PutObjectAcl",
"s3:ReplicateObject",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::<BUCKET_NAME>",
"arn:aws:s3:::<BUCKET_NAME>/*"
]
}
]
}

'''Note for manual migration only''': files in AWS S3 are stored with a prefix corresponding to the file asset type. For example, a file1.png that is a client file will be stored as /client_files/file1.png. Use the following sub-folder names per file type:

* Client Files - client_files
* Downloads - downloads
* Email Attachments - email_attachments
* Email Template Attachments - template_attachments
* Project Management Files - pm_files
* Ticket Attachments - ticket_attachments

When using automatic migration, you do not have to worry about these prefixes - they are managed automatically.

===Migrating Between Two AWS S3 locations===

In addition to Amazon AWS S3, WHMCS supports AWS S3 compatible services such as Ceph. However, automatic migration between two S3 locations is only supported if both locations are kept with the same storage provider.

===Migrating From S3 To Local Storage===

This migration can be done the same way as the other migration paths, with the same considerations and expectations equally applicable.

===General Considerations===
Please note that "Email Attachments" cannot be automatically migrated (as opposed to email template attachments). These files are uploaded when creating a custom email message, and are of transient nature. To avoid any inconsistencies when switching storage settings for email attachments, it should be sufficient to ensure that no administrator users are in process of composing an email message with attachments. Please note that email template attachments are a separate asset type and can be migrated automatically.

===Troubleshooting a File Not Found Error===
If you experience a "File not found" error, this may mean that a file is not present or is not accessible at the expected location. To validate that a file is present in the local storage, check that the file exists and its permissions allow access to the web user. For AWS S3, use AWS (or your compatible storage provider's) console to verify that the file is stored with the indicated key.

A convenient way to confirm storage location accessibility is to use "Test Configuration" feature. To do that, go to '''Setup > Storage Settings''', click "Configurations" tab, choose a configuration you want tested, and click the "Test" icon. For AWS S3 (or compatible providers) this should also indicate if there are any issues with the Access Key / Access Secret provided.

Storage Settings

2018-12-28T19:01:37Z

Artem: /* AWS S3 */

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.7 and above</div>

Storage settings allow storing files outside of your WHMCS installation, reducing web space requirements. Prior to version 7.7, WHMCS only supported local storage. With version 7.7, we have introduced Amazon AWS S3 and compatible services for file storage needs.

==How it Works==

By default files will be stored locally within the WHMCS install. If you upgrade an existing WHMCS install to version 7.7 or later, any custom settings for attachments directory and/or downloads directory will be retained and any files will remain in their existing locations. However you may opt to migrate select file types to Amazon AWS S3 or a compatible service. WHMCS offers automatic migrations of your existing files to and from AWS S3, as well as between AWS S3 locations.

==Configuration==

To manage your storage settings, navigate to '''Setup > Storage Settings'''. Choose one of the following workflows depending on the desired use case.

===Local Storage===

You may desire to migrate files from an existing local storage location to another local directory. To do that:

#Click "Configuration" tab
#In "Add New Configuration" tile, choose "Local Storage" or and click "Add".
#Enter path to the new storage location. The directory must exist and be writable. Click "Save".
#Switch to "Settings" tab.
#Select the new storage location for the file type that you wish to migrate to the new location.
#Most file types can be migrated automatically, and you will be prompted to start migration by clicking "Migrate" button. For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location. If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location. Former location will not be automatically cleaned - you may want to clean it manually once you validate that the migration was successful.
#You may choose to cancel an ongoing migration. The present location will then continue to be used. Files migrated to the new location until this point will not be deleted.
#Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file types storage setting at once. This will skip automatic migration and assumes your responsibility for moving the files to the new location. If you elect this path, please note that certain file types may be stored by WHMCS in the same folder (for example, client files, email and ticket attachments as well as project management files will be stored in "attachments" folder). If you decide to move all the files away from that folder, all relevant file types must be switched to the new location.
#If you made a change by mistake, click "Revert Changes" to cancel any changes.

===AWS S3===

You may desire to migrate files to an AWS S3 bucket or a compatible service. To do that:

#Click "Configuration" tab
#In "Add New Configuration" tile, choose "S3" or and click "Add".
#Enter AWS S3 connection details. S3 region must be specified as a code name, e.g. "us-east-1" for "US East (N. Virginia)" - if you need a region code name for your bucket's region, [https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html click here] for a list of all available AWS regions and their code names. You do not need to enter the "Endpoint URL" if using Amazon AWS S3 service - this field is only required if using a non-Amazon, S3-compatible storage provider. The S3 access credentials must have read and write access to the specified S3 bucket. See below for an example of a suitable policy for the S3 user.
#Click "Save". If the bucket cannot be accessed, an error message will be shown.
#Switch to "Settings" tab.
#Select the new storage location for the file type that you wish to migrate to the new location.
#As with local storage, most file types can be migrated automatically, and you will be prompted to start migration by clicking "Migrate" button. For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location. If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location. Former location will not be automatically cleaned - you may want to clean it manually once you validate that the migration was successful.
#You may choose to cancel an ongoing migration. The present location will then continue to be used. Files migrated to the new location until this point will not be deleted.
#Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file types storage setting at once. This will skip automatic migration and assumes your responsibility for moving the files to the new location. If you elect this path, please note that certain file types may be stored by WHMCS in the same folder (for example, client files, email and ticket attachments as well as project management files will be stored in "attachments" folder). If you decide to move all the files away from that local folder, all relevant file types must be switched to the new location.
#If you made a change by mistake, click "Revert Changes" to cancel any changes.

An example AWS S3 policy to be assigned to the S3 user for use with WHMCS storage settings:

{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "Stmt1111222223333",
"Effect": "Allow",
"Action": [
"s3:ListBucket",
"s3:GetObject",
"s3:GetObjectAcl",
"s3:PutObject",
"s3:PutObjectAcl",
"s3:ReplicateObject",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::<BUCKET_NAME>",
"arn:aws:s3:::<BUCKET_NAME>/*"
]
}
]
}

'''Note for manual migration only''': files in AWS S3 are stored with a prefix corresponding to the file asset type. For example, a file1.png that is a client file will be stored as /client_files/file1.png. Use the following sub-folder names per file type:

* Client Files - client_files
* Downloads - downloads
* Email Attachments - email_attachments
* Email Template Attachments - template_attachments
* Project Management Files - pm_files
* Ticket Attachments - ticket_attachments

When using automatic migration, you do not have to worry about these prefixes - they are managed automatically.

===Migrating Between Two AWS S3 locations===

In addition to Amazon AWS S3, WHMCS supports AWS S3 compatible services such as Ceph. However, automatic migration between two S3 locations is only supported if both locations are kept with the same storage provider.

===Migrating From S3 To Local Storage===

This migration can be done the same way as the other migration paths, with the same considerations and expectations equally applicable.

===General Considerations===
Please note that "Email Attachments" cannot be automatically migrated (as opposed to email template attachments). These files are uploaded when creating a custom email message, and are of transient nature. To avoid any inconsistencies when switching storage settings for email attachments, it should be sufficient to ensure that no administrator users are in process of composing an email message with attachments. Please note that email template attachments are a separate asset type and can be migrated automatically.

General Configuration

2018-12-19T20:12:00Z

Artem:

<noinclude>
{{Setup/Configuration}}

This section contains documentation related to general configuration:
</noinclude>
* [[Configuration|General Settings]]
* [[Sign-In Integrations]]
* [[Automation Settings]]
* [[MarketConnect]]
* [[Storage Settings]]
* [[Administrators and Permissions]]
* [[Two-Factor Authentication]]
* [[Application Links]]
* [[Email Templates]]
* [[Client Groups]]
* [[Custom Fields]]
* [[Fraud Protection]]
* [[Order Statuses]]
* [[Security Questions]]

General Configuration

2018-12-19T19:40:27Z

Artem:

<noinclude>
{{Setup/Configuration}}

This section contains documentation related to general configuration:
</noinclude>
* [[Configuration|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]]

General Configuration

2018-12-19T19:30:39Z

Artem:

Storage Settings

2018-12-19T19:07:02Z

Artem:

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.7 and above</div>

Storage settings allow storing files outside of your WHMCS installation, reducing web space requirements. Prior to version 7.7, WHMCS only supported local storage. With version 7.7, we have introduced Amazon AWS S3 and compatible services for file storage needs.

==How it Works==

By default files will be stored locally within the WHMCS install. If you upgrade an existing WHMCS install to version 7.7 or later, any custom settings for attachments directory and/or downloads directory will be retained and any files will remain in their existing locations. However you may opt to migrate select file types to Amazon AWS S3 or a compatible service. WHMCS offers automatic migrations of your existing files to and from AWS S3, as well as between AWS S3 locations.

==Configuration==

To manage your storage settings, navigate to '''Setup > Storage Settings'''. Choose one of the following workflows depending on the desired use case.

===Local Storage===

You may desire to migrate files from an existing local storage location to another local directory. To do that:

#Click "Configuration" tab
#In "Add New Configuration" tile, choose "Local Storage" or and click "Add".
#Enter path to the new storage location. The directory must exist and be writable. Click "Save".
#Switch to "Settings" tab.
#Select the new storage location for the file type that you wish to migrate to the new location.
#Most file types can be migrated automatically, and you will be prompted to start migration by clicking "Migrate" button. For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location. If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location. Former location will not be automatically cleaned - you may want to clean it manually once you validate that the migration was successful.
#You may choose to cancel an ongoing migration. The present location will then continue to be used. Files migrated to the new location until this point will not be deleted.
#Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file types storage setting at once. This will skip automatic migration and assumes your responsibility for moving the files to the new location. If you elect this path, please note that certain file types may be stored by WHMCS in the same folder (for example, client files, email and ticket attachments as well as project management files will be stored in "attachments" folder). If you decide to move all the files away from that folder, all relevant file types must be switched to the new location.
#If you made a change by mistake, click "Revert Changes" to cancel any changes.

===AWS S3===

You may desire to migrate files to an AWS S3 bucket or a compatible service. To do that:

#Click "Configuration" tab
#In "Add New Configuration" tile, choose "S3" or and click "Add".
#Enter AWS S3 connection details. You do not need to enter the "Endpoint URL" if using Amazon AWS S3 service - this field is only required if using a non-Amazon, S3-compatible storage provider. The S3 access credentials must have read and write access to the specified S3 bucket. See below for an example of a suitable policy for the S3 user.
#Click "Save". If the bucket cannot be accessed, an error message will be shown.
#Switch to "Settings" tab.
#Select the new storage location for the file type that you wish to migrate to the new location.
#As with local storage, most file types can be migrated automatically, and you will be prompted to start migration by clicking "Migrate" button. For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location. If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location. Former location will not be automatically cleaned - you may want to clean it manually once you validate that the migration was successful.
#You may choose to cancel an ongoing migration. The present location will then continue to be used. Files migrated to the new location until this point will not be deleted.
#Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file types storage setting at once. This will skip automatic migration and assumes your responsibility for moving the files to the new location. If you elect this path, please note that certain file types may be stored by WHMCS in the same folder (for example, client files, email and ticket attachments as well as project management files will be stored in "attachments" folder). If you decide to move all the files away from that local folder, all relevant file types must be switched to the new location.
#If you made a change by mistake, click "Revert Changes" to cancel any changes.

An example AWS S3 policy to be assigned to the S3 user for use with WHMCS storage settings:

{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "Stmt1111222223333",
"Effect": "Allow",
"Action": [
"s3:ListBucket",
"s3:GetObject",
"s3:GetObjectAcl",
"s3:PutObject",
"s3:PutObjectAcl",
"s3:ReplicateObject",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::<BUCKET_NAME>",
"arn:aws:s3:::<BUCKET_NAME>/*"
]
}
]
}

'''Note for manual migration only''': files in AWS S3 are stored with a prefix corresponding to the file asset type. For example, a file1.png that is a client file will be stored as /client_files/file1.png. Use the following sub-folder names per file type:

* Client Files - client_files
* Downloads - downloads
* Email Attachments - email_attachments
* Email Template Attachments - template_attachments
* Project Management Files - pm_files
* Ticket Attachments - ticket_attachments

When using automatic migration, you do not have to worry about these prefixes - they are managed automatically.

===Migrating Between Two AWS S3 locations===

In addition to Amazon AWS S3, WHMCS supports AWS S3 compatible services such as Ceph. However, automatic migration between two S3 locations is only supported if both locations are kept with the same storage provider.

===Migrating From S3 To Local Storage===

This migration can be done the same way as the other migration paths, with the same considerations and expectations equally applicable.

===General Considerations===
Please note that "Email Attachments" cannot be automatically migrated (as opposed to email template attachments). These files are uploaded when creating a custom email message, and are of transient nature. To avoid any inconsistencies when switching storage settings for email attachments, it should be sufficient to ensure that no administrator users are in process of composing an email message with attachments. Please note that email template attachments are a separate asset type and can be migrated automatically.

Storage Settings

2018-12-19T17:15:41Z

Artem: Created page with "<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.7 and above</div> Storage settings allow storing files out..."

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.7 and above</div>

Storage settings allow storing files outside of your WHMCS installation, reducing web space requirements. At this time WHMCS only supports local storage as well as Amazon AWS S3 and compatible services.

==How it Works==

By default files will be stored locally within the WHMCS install. If you upgrade an existing WHMCS install to version 7.7 or later, any custom settings for attachments directory and/or downloads directory will be retained and any files will remain in their existing locations. However you may opt to migrate select file types to Amazon AWS S3 or a compatible service. WHMCS offers automatic migrations of your existing files to and from AWS S3, as well as between AWS S3 locations.

==Configuration==

To manage your storage settings, navigate to '''Setup > Storage Settings'''. Choose one of the following workflows depending on the desired use case.

===Local Storage===

You may desire to migrate files from an existing local storage location to another local directory. To do that:

#Click "Configuration" tab
#In "Add New Configuration" tile, choose "Local Storage" or and click "Add".
#Enter path to the new storage location. The directory must exist and be writable. Click "Save".
#Switch to "Settings" tab.
#Select the new storage location for the file type that you wish to migrate to the new location.
#Most file types can be migrated automatically, and you will be prompted to start migration by clicking "Migrate" button. For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location. If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location. Former location will not be automatically cleaned - you may want to clean it manually once you validate that the migration was successful.
#You may choose to cancel an ongoing migration. The present location will then continue to be used. Files migrated to the new location until this point will not be deleted.
#Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file types storage setting at once. This will skip automatic migration and assumes your responsibility for moving the files to the new location. If you elect this path, please note that certain file types may be stored by WHMCS in the same folder (for example, client files, email and ticket attachments as well as project management files will be stored in "attachments" folder). If you decide to move all the files away from that folder, all relevant file types must be switched to the new location.
#If you made a change by mistake, click "Revert Changes" to cancel any changes.

===AWS S3===

You may desire to migrate files to an AWS S3 bucket or a compatible service. To do that:

#Click "Configuration" tab
#In "Add New Configuration" tile, choose "S3" or and click "Add".
#Enter AWS S3 connection details. You do not need to enter the "Endpoint URL" if using Amazon AWS S3 service - this field is only required if using a non-Amazon, S3-compatible storage provider. The S3 access credentials must have read and write access to the specified S3 bucket. See below for an example of a suitable policy for the S3 user.
#Click "Save". If the bucket cannot be accessed, an error message will be shown.
#Switch to "Settings" tab.
#Select the new storage location for the file type that you wish to migrate to the new location.
#As with local storage, most file types can be migrated automatically, and you will be prompted to start migration by clicking "Migrate" button. For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location. If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location. Former location will not be automatically cleaned - you may want to clean it manually once you validate that the migration was successful.
#You may choose to cancel an ongoing migration. The present location will then continue to be used. Files migrated to the new location until this point will not be deleted.
#Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file types storage setting at once. This will skip automatic migration and assumes your responsibility for moving the files to the new location. If you elect this path, please note that certain file types may be stored by WHMCS in the same folder (for example, client files, email and ticket attachments as well as project management files will be stored in "attachments" folder). If you decide to move all the files away from that local folder, all relevant file types must be switched to the new location.
#If you made a change by mistake, click "Revert Changes" to cancel any changes.

An example AWS S3 policy to be assigned to the S3 user for use with WHMCS storage settings:

{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "Stmt1111222223333",
"Effect": "Allow",
"Action": [
"s3:ListBucket",
"s3:GetObject",
"s3:GetObjectAcl",
"s3:PutObject",
"s3:PutObjectAcl",
"s3:ReplicateObject",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::<BUCKET_NAME>",
"arn:aws:s3:::<BUCKET_NAME>/*"
]
}
]
}

'''Note for manual migration only''': files in AWS S3 are stored with a prefix corresponding to the file asset type. For example, a file1.png that is a client file will be stored as /client_files/file1.png. Use the following sub-folder names per file type:
- Client Files - client_files
- Downloads - downloads
- Email Attachments - email_attachments
- Email Template Attachments - template_attachments
- Project Management Files - pm_files
- Ticket Attachments - ticket_attachments

When using automatic migration, you do not have to worry about these prefixes - they are managed automatically.

===Migrating Between Two AWS S3 locations===

In addition to Amazon AWS S3, WHMCS supports AWS S3 compatible services such as Ceph. However, automatic migration between two S3 locations is only supported if both locations are kept with the same storage provider.

===Migrating From S3 To Local Storage===

This migration can be done the same way as the other migration paths, with the same considerations and expectations equally applicable.

===General Considerations===
Please note that "Email Attachments" cannot be automatically migrated (as opposed to email template attachments). These files are uploaded when creating a custom email message, and are of transient nature. To avoid any inconsistencies when switching storage settings for email attachments, it should be sufficient to ensure that no administrator users are in process of composing an email message with attachments. Please note that email template attachments are a separate asset type and can be migrated automatically.

Configuring Sign-In using Twitter

2018-09-24T16:47:14Z

Artem: /* Configuring Sign-In with Twitter */

This article is part of the [[Sign-In Integrations]] feature.

==Purpose==

Enabling the Twitter Sign In Integration enables visitors and customers to register, sign in and connect their Twitter accounts with your WHMCS installation for faster sign-up and automatic sign-in.

[[File:Signinintegrationslogin.png]]

==Configuring Sign-In with Twitter==

[[File:Videotutorial.png‎|center|link=https://vimeo.com/231458433|Watch Video Tutorial]]

There are 2 steps required to setup Sign-In with Twitter:

# Create a Twitter App and Retrieve API Credentials
# Activate Twitter Sign In within WHMCS

===Create a Twitter App and Retrieve API Credentials===

Twitter Sign In Integration requires a Twitter App and API Credential Set. You can create this using your existing Twitter account. Users will only see the App Name you define and not see anything relating to the account you use to create the project.

<div class="docs-alert-warning">Be aware that the Twitter account under which you create the app can not be changed without requiring users to re-authenticate and re-link their accounts so it is important to set the app up under an account that you will always have access to.</div>

1. Visit https://apps.twitter.com/ <br>
2. If not logged in, login to your Twitter account <br>
3. Click the '''Create New App''' button

[[File:Twittersign1.png]]

4. Enter a Name, Description and Website URL for your App.

You must also enter a valid URL in the Callback URL fields. The URL you enter here is not used, but the valid URL of the callback file must be defined to enable WHMCS to utilize callbacks.

Because there are three possible callback URLs depending upon the Friendly URLs feature setting, we suggest adding all three:

* http://demo.whmcs.com/whmcs/index.php
* http://demo.whmcs.com/whmcs/index.php/auth/provider/twitter_oauth/callback
* http:///demo.whmcs.com/whmcs/auth/provider/twitter_oauth/callback

Replace <i><nowiki>http://demo.whmcs.com/whmcs/</nowiki></i> with the actual URL of your WHMCS installation

[[File:Twittersign2.png]]

5. If you do not yet have a phone number defined inside your Twitter account, you will see the following error upon submitting. To create an App, Twitter requires that you have a valid phone number registered in your account with them. You must do this before continuing.

[[File:Twittersign3.png]]

6. After submitting the App Creation form, you should see a success confirmation page that looks as follows.

[[File:Twittersign4.png]]

7. Select the '''Settings''' tab. In the Application Details section, ensure that the ''Enable Callback Locking'' option is disabled.

[[File:Twittersign7.png]]

8. Select the '''Permissions''' tab. WHMCS only requires Read permissions so you can change the default Access permission level to ''Read only''. Then hit '''Update Settings'''

[[File:Twittersign5.png]]

9. Now select the '''Keys and Access Tokens''' tab. Your API Key and Secret will then be displayed. These are the values you will need to activate Twitter Sign In within WHMCS so store these in a safe place.

[[File:Twittersign6.png]]

You can now proceed to Activate Twitter Sign In within WHMCS.

===Activate Twitter Sign In within WHMCS===

# Login to the WHMCS Admin Area
# Navigate to Setup > Sign-In Integrations
# Select Activate under the Twitter heading
# Enter your Twitter API Key and API Secret where requested
# Click Save & Activate

WHMCS will attempt to validate and test the details you have entered. If the API Key and Secret are valid and successfully authenticate with the Twitter API, the values will be saved and the modal will close.

Congratulations! Twitter Sign In is now enabled.

==Troubleshooting==

For troubleshooting help, please refer to [[Troubleshooting Sign-In using Twitter]]

Configuring Sign-In using Twitter

2018-09-24T16:46:31Z

Artem: /* Create a Twitter App and Retrieve API Credentials */

This article is part of the [[Sign-In Integrations]] feature.

==Purpose==

Enabling the Twitter Sign In Integration enables visitors and customers to register, sign in and connect their Twitter accounts with your WHMCS installation for faster sign-up and automatic sign-in.

[[File:Signinintegrationslogin.png]]

==Configuring Sign-In with Twitter==

[[File:Videotutorial.png‎|center|link=https://vimeo.com/231458433|Watch Video Tutorial]]

There are 2 steps required to setup Sign-In with Twitter:

# Create a Twitter App and Retrieve API Credentials
# Activate Twitter Sign In within WHMCS

===Create a Twitter App and Retrieve API Credentials===

Twitter Sign In Integration requires a Twitter App and API Credential Set. You can create this using your existing Twitter account. Users will only see the App Name you define and not see anything relating to the account you use to create the project.

<div class="docs-alert-warning">Be aware that the Twitter account under which you create the app can not be changed without requiring users to re-authenticate and re-link their accounts so it is important to set the app up under an account that you will always have access to.</div>

1. Visit https://apps.twitter.com/ <br>
2. If not logged in, login to your Twitter account <br>
3. Click the '''Create New App''' button

[[File:Twittersign1.png]]

4. Enter a Name, Description and Website URL for your App.

You must also enter a valid URL in the Callback URL fields. The URL you enter here is not used, but the valid URL of the callback file must be defined to enable WHMCS to utilize callbacks.

Because there are a few possible callback URLs depending upon the Friendly URLs feature setting, we suggest adding all three:

* http://demo.whmcs.com/whmcs/index.php
* http://demo.whmcs.com/whmcs/index.php/auth/provider/twitter_oauth/callback
* http:///demo.whmcs.com/whmcs/auth/provider/twitter_oauth/callback

Replace <i><nowiki>http://demo.whmcs.com/whmcs/</nowiki></i> with the actual URL of your WHMCS installation

[[File:Twittersign2.png]]

5. If you do not yet have a phone number defined inside your Twitter account, you will see the following error upon submitting. To create an App, Twitter requires that you have a valid phone number registered in your account with them. You must do this before continuing.

[[File:Twittersign3.png]]

6. After submitting the App Creation form, you should see a success confirmation page that looks as follows.

[[File:Twittersign4.png]]

7. Select the '''Settings''' tab. In the Application Details section, ensure that the ''Enable Callback Locking'' option is disabled.

[[File:Twittersign7.png]]

8. Select the '''Permissions''' tab. WHMCS only requires Read permissions so you can change the default Access permission level to ''Read only''. Then hit '''Update Settings'''

[[File:Twittersign5.png]]

9. Now select the '''Keys and Access Tokens''' tab. Your API Key and Secret will then be displayed. These are the values you will need to activate Twitter Sign In within WHMCS so store these in a safe place.

[[File:Twittersign6.png]]

You can now proceed to Activate Twitter Sign In within WHMCS.

===Activate Twitter Sign In within WHMCS===

# Login to the WHMCS Admin Area
# Navigate to Setup > Sign-In Integrations
# Select Activate under the Twitter heading
# Enter your Twitter API Key and API Secret where requested
# Click Save & Activate

WHMCS will attempt to validate and test the details you have entered. If the API Key and Secret are valid and successfully authenticate with the Twitter API, the values will be saved and the modal will close.

Congratulations! Twitter Sign In is now enabled.

==Troubleshooting==

For troubleshooting help, please refer to [[Troubleshooting Sign-In using Twitter]]

Version 7.5.0 Release Notes

2018-07-31T14:08:02Z

Artem: /* Automatic Updating */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 7.5<br />
Release Type: General Availability<br />
Release Date: 2nd April 2018<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><th>Version</th><th>Release Type</th><th>Release Date</th></tr>
<tr><td>7.5.2</td><td>Security Patch</td><td>17th July 2018</td></tr>
<tr><td>7.5.1</td><td>Maintenance</td><td>17th April 2018</td></tr>
<tr><td>7.5.0</td><td>General Availability</td><td>2nd April 2018</td></tr>
<tr><td>7.5.0</td><td>Release Candidate 1</td><td>8th March 2018</td></tr>
<tr><td>7.5.0</td><td>Beta 1</td><td>22nd February 2018</td></tr>
</table>

==Download==
Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==
[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===
If you are running WHMCS 7.0 or later, you can use the built-in Automatic Update utility.

Simply navigate to ''Utilities > Update WHMCS'' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>  If the update was released recently, you may need to click the Check for Updates button before the update will show as available.</div>

<div class="docs-alert-warning">WHMCS v7.5.0 requires Ioncube Loader 10.1 or higher. The Automatic Updater verifies this requirement for you in v7.4.2. If you are using the Automatic Updater and are not yet on v7.4.2, then you will not see the v7.5.0 update but only v7.4.2. Use the Auto Updater to first update to v7.4.2. After this, v7.5.0 will be visible and the Automatic Updater will be able to verify all requirements before proceeding to this latest version.</div>

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>  '''BETA and RC users on PHP 7.1 or 7.2''' will need to temporarily switch to PHP 7.0 in order to utilize the automatic updater. This is due to a PHP 7.1/7.2 incompatibility in the phpseclib validation library. This has been resolved in CORE-12119. Once you have updated to the General Availability release, you may switch back to PHP 7.1/7.2.</div>

For more information about the Automatic Updater and troubleshooting please refer to the [[Automatic Updater]] documentation.

== Release Notes ==

* '''Support for PHP 7.1 & 7.2''' - WHMCS v7.5 and greater now supports PHP 7.1 and 7.2. Support is also still provided for PHP Versions 5.6 and 7.0. Because of this broad environment support, no immediate action is required to upgrade to WHMCS v7.5 other than having the latest Ioncube Loader 10.1. We have created a [[PHP 7 Migration Guide]] to guide you through the process of switching to PHP 7.1 or PHP 7.2 should you wish to do so.

* '''PHP Version Compatibility Utility''' - A new utility is being provided in WHMCS 7.5 to help you verify the compatibility of ionCube encoded files with different versions of PHP. Accessed via a new option found under ''Utilities > System'', our [[PHP Version Compatibility Assessment|PHP Version Compatibility Assessment Tool]] is designed to give you transparency for files that you may have deployed over the lifespan of your installation that appear to be ionCube encoded. Learn more in the [[PHP Version Compatibility Assessment|documentation]]

* '''Domain Grace and Redemption Grace Periods Support''' - WHMCS now supports Domain Grace and Redemption Grace Periods for domains, along with the automatic applying of fees related to Grace and Redemption Periods. Learn more at [[Domain Grace and Redemption Grace Periods|in the documentation]] and our [https://blog.whmcs.com/133425/feature-spotlight-domain-grace-and-redemption-fee-automation recent blog post]

* '''Bulk TLD Pricing Management''' - New bulk management features have been added to make working with large numbers of extensions and TLDs easier. Found in the 'Setup > Products/Services > Domain Pricing'' page, a new Bulk Management panel allows you to make changes to domain pricing, grace period and redemption period settings for groups of TLDs at a time.

* '''Improved Domain Renewals Experience''' - WHMCS 7.5 includes changes to the client area domain renewal experience including a new unified page for ordering renewals via the shopping cart, live real-time cart preview, more informative and helpful information display, domain search for customers with lots of domains + new grace and redemption period information and pricing display.

* '''Staff Mentions''' - You can now mention other staff members using the familiar @mention syntax when creating client or ticket notes for those users to receive an email notification regarding your note. Learn more at [[Staff Mentions]]

* '''Competitive Upgrade for SSL''' - Competitive Upgrade allows customers with existing SSL certificates from qualifying competing vendors to purchase an SSL Certificate from you without losing any time. Learn more about this and how it works in the [https://marketplace.whmcs.com/help/connect/kb/symantec_ssl_certificates/purchase_flow/competitive_upgrade_qualifying_orders documentation here]

* '''Password Generation for Provisioning''' - WHMCS v7.5 introduces a new default behaviour for the automatic generation of passwords for provisioning of new services. The default password complexity has been increased to consist of 14 characters, containing both lower and uppercase letters, numbers and symbols. If you wish to continue using the previous auto generated password format, you can do so by navigating to ''Setup > General Settings > Security'' and selecting the option ''Generate passwords containing a combination of letters and numbers only'' under the '''Auto Generated Password Format''' setting.

* '''Client Tickets Overview Tab''' - Quicker more convenient access to view a customers ticket history without leaving the client profile. Now available via the admin area client profile.

* '''Affiliate Referral Tracking''' - Get deeper insights into where your affiliate referral traffic is coming from, and see trends in the volume of traffic over time. Learn more at [[Affiliates#Referral_Tracking|Affiliate Referral Tracking]]

* '''Admin Setup Dashboard''' - A new, faster and more convenient way to browse and find the setup or configuration option you're looking for. Simply click the Setup tab within the admin area to access the new dashboard which provides ability to search for setup pages and a setup checklist designed to help new users to the product get up and running more quickly.

* '''Changes to help you be ready for GDPR''' - Various new features and functionality has been added to help you be prepared for the new GDPR regulations which come into effect in May 2018. Learn more in [https://blog.whmcs.com/133437/how-whmcs-can-help-with-gdpr-compliance our recent blog post]

* '''Marketing Emails Consent''' - New functionality has been added that enables you to request your customers to opt-in or opt-out from marketing emails during checkout and registration. A new consent log will maintain a history of customers opt-in and opt-out requests, and new email template merge fields have also been made available to allow users to opt-in or opt-out at any time. Learn more at [[Marketing Emails Automation]]

* '''Data Retention Policy Automation''' - New functionality has been added to allow automatic enforcement of your client data retention policy. Learn more at [[Data Retention Policy Automation]]

* '''MarketConnect - SiteLock''' - The new SiteLock integration allows you to offer Website Security services to your customers that includes scanning, detection and automatic removal of malware from websites as well as WAF and CDN services. Learn more in our [https://marketplace.whmcs.com/help/connect/kb/sitelock_website_security SiteLock Documentation] and [https://blog.whmcs.com/133449/start-offering-sitelock-for-free-today our recent blog post]

* '''MarketConnect Upgrades''' - Upgrades are now supported for SpamExperts, Weebly and SiteLock MarketConnect services. This allows users to upgrade from one plan level to another higher plan level. The upgrade functionality can be accessed via Upgrade buttons located within the client area and is available for all MarketConnect services which have multiple levels of plan offering. Note that only upgrades are supported, not downgrades, and that upgrades must be to plans with an equal or longer billing cycle. For more information see [https://marketplace.whmcs.com/help/connect/kb/overview/general/service_upgrades the documentation]

* '''MarketConnect SSL Landing Page Updates''' - WHMCS 7.5 introduces new promotional content to the SSL landing pages. It is important to apply all the template changes itemised in the changes below to ensure you have the latest promotional copy and new Competitive Upgrade SSL functionality.

* '''MarketConnect Cart Integration''' - Active MarketConnect product groups will now be shown within the Shopping Cart sidebar and the relevant landing pages will be displayed when those product groups are selected.

* '''MarketConnect - Dashboard Widget''' - A new dashboard widget provides an overview of active MarketConnect services and allows you to keep track of your available balance more easily.

* '''Attachments support in Ticket Related APIs''' - The API functions OpenTicket, AddTicketReply and AddTicketNote now support attachments. Learn how to use them in our [https://developers.whmcs.com/api-reference/ API Reference Documentation]

== Deprecation & Removal Notices ==

* '''VentraIP''' - VentraIP, the domain registrar module for VentraIP Wholesale, has been updated to Synergy. Synergy Wholesale provides their latest integration on the WHMCS Marketplace, https://marketplace.whmcs.com/product/3757. As a result, the module of the company's former integration will no longer be distributed or maintained in future WHMCS releases. This module will be removed from your WHMCS system if not in use upon upgrade to v7.5.0.

* '''Legacy Module Removal''' - During the v7.5.0 update, a one-time routine will inspect and attempt to remove legacy & deprecated modules. This will reduce the possibility of code incompatibility if you decide to update your environment in the near future. Removal will only occur if it is not actively in use. The Activity Log will have a list of any removals. As well, if removal is not performed and the module remains in your installation, an email will be generated for all full admins so that further investigation can be performed. Inspection will be performed for the following modules: Addons - fixed_invoice_data; Fraud - telesign, varilogix_fraudcall; Gateways - alertpay, bidpay, egold, eway, ewayuk, gocardless, googlecheckout, ideal, internetsecure, libertyreserve, myideal, openecho, payoffline, stormpay; Registrars - directi, dottk, netregistry, planetdomains, registerfly, resellerclubbeta, tppinternet, ventraip; Servers - castcontrol, dotnetpanel, enkompass, enomtruste, ensimx, fluidvm, plesk10, plesk8, plesk9, pleskreseller.

* '''Legacy File & Directory Removal''' - During the v7.5.0 update, a one-time routine will inspect and attempt to remove the following legacy file resources: admin/lang/adminlangupdate.php, includes/classes/, includes/whoisfunctions.php

== New Documentation ==

The following new documentation pages are available:

* [[Domain Grace and Redemption Grace Periods]]
* [[Staff Mentions]]
* [[Marketing Emails Automation]]
* [[Data Retention Policy Automation]]
* [[SiteLock via WHMCS MarketConnect]]
* [[Setup Tasks|Admin Setup Tasks]]
* [[Affiliates#Referral_Tracking|Affiliate Referral Tracking]]
* [[PHP_Version_Compatibility_Assessment|PHP Version Compatibility Assessment]]
* [[PHP_7_Migration_Guide|PHP 7 Migration Guide]]

== Template Changes ==

For a list of changed files and graphical view of the exact changes, please refer to the Github repo's below.

=== Six Template ===

The following link provides a comparison of changes between 7.4.2 and 7.5.2:
https://github.com/WHMCS/templates-six/compare/v7.4.2-release.1...v7.5.2-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 7.4.2 and 7.5.2:
https://github.com/WHMCS/orderforms-standard_cart/compare/v7.4.2-release.1...v7.5.2-release.1

== Changelog ==
* [[Changelog:WHMCS_V7.5.2|Version 7.5.2 Security Patch]]
* [[Changelog:WHMCS_V7.5.1|Version 7.5.1 Maintenance]]
* [[Changelog:WHMCS_V7.5.0_GA|Version 7.5.0 General Release]]
* [[Changelog:WHMCS_V7.5.0_RC_1|Version 7.5.0 Release Candidate 1]]
* [[Changelog:WHMCS_V7.5.0_Beta_1|Version 7.5.0 Beta 1]]

Version 7.6.0 Release Notes

2018-07-31T14:04:53Z

Artem: /* Automatic Updating */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 7.6<br />
Release Type: General Availability<br />
Release Date: 31st July 2018<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><th>Version</th><th>Release Type</th><th>Release Date</th></tr>
<tr><td>7.6.0</td><td>General Release</td><td>31st July 2018</td></tr>
<tr><td>7.6.0</td><td>Release Candidate 1</td><td>17th July 2018</td></tr>
<tr><td>7.6.0</td><td>Beta 1</td><td>28th June 2018</td></tr>
</table>

==Download==
Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==
[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===
If you are running WHMCS 7.0 or later, you can use the built-in Automatic Update utility.

Simply navigate to ''Utilities > Update WHMCS'' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>  If the update was released recently, you may need to click the Check for Updates button before the update will show as available.</div>

<div class="docs-alert-warning">WHMCS v7.6.0 requires Ioncube Loader 10.1 or higher. The Automatic Updater verifies this requirement for you in v7.4.2. If you are using the Automatic Updater and are not yet on v7.4.2, then you will not see the v7.6.0 update but only v7.4.2. Use the Auto Updater to first update to v7.4.2. After this, v7.6.0 will be visible and the Automatic Updater will be able to verify all requirements before proceeding to this latest version.</div>

For more information about the Automatic Updater and troubleshooting please refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== WHMCS Namespinning ===
Introducing new and improved Domain Namespinning from WHMCS. WHMCS Namespinning ranks and returns relevant domain name suggestions across a wide range of TLDs to help drive more domain registrations. Utilising machine learning technology, WHMCS Namespinning delivers more relevant suggestions by working to understand the context of your customer’s queries, delivers marketing leading speed and performance plus has multi-language support. WHMCS Namespinning is being made available free of charge to all WHMCS users.

WHMCS Namespinning is enabled by default for new installations. On upgrade, if you are currently using the WHMCS Standard WHOIS, you will be automatically upgraded to use the new Domain Namespinning feature. To change this behaviour, navigate to Setup > Domain Registrars > Lookup Provider after upgrading.

Domain availability lookup and domain name suggestions continues to be a distinct feature from domain order fulfillment. You can use WHMCS Namespinning with any registrar.

=== Font Awesome 5 ===
There are a significant number of changes to the naming and styling of icons, and while we've done our best to minimise changes, there are a number of template changes required by the Font Awesome 5 migration.

It is important to take care to apply all of these changes to your custom templates to avoid missing or broken icons. You can learn more how to upgrade your customisations by reviewing the Font Awesome [https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4 Upgrading from version 4] document. If you desire, Font Awesome does provide a [https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4#shims shim] that can dynamically convert v4 style to v5 style on page load, however we do not recommend this for long term usage due to the potential for visual, behavior, and performance impacts.

=== New MaxMind Functionality ===
WHMCS 7.6 includes changes to the MaxMind module, including the update to a newer MaxMind API, which requires a MaxMind User ID to be provided for authentication. If MaxMind is enabled in WHMCS, you '''must''' enter your MaxMind User ID for fraud checking to continue functioning. Failure to enter the User ID will result in MaxMind API requests failing. It is important to note that a MaxMind fraud check failure due to bad user credentials results being treated as a fraud check pass.

To enter the User ID, an administrative user with appropriate permissions needs to visit Setup > Fraud Protection > MaxMind, and enter the User ID into the appropriate field. To obtain your User ID from MaxMind, login at [https://www.maxmind.com https://www.maxmind.com] and visit the "My License Key" page.

The newer API integration in WHMCS 7.6 also makes available the Score, Insights and Factors MaxMind services.

=== New Weebly Plans ===
WHMCS 7.6 makes available two new Weebly plans via MarketConnect. These plans include:
# Weebly Lite - an entry level offering for a single page site for just $1.99/mo (RRP)
# Weebly Performance - an e-commerce option designed for power sellers providing additional e-commerce related functionality

On upgrade, if Weebly is active and enabled within your WHMCS installation, the two new plans will be created and made available automatically.

To learn more about Weebly or modify or disable the new plans, simply navigate to Setup > MarketConnect > Weebly after upgrading.

=== MarketConnect UX Updates ===
MarketConnect has a number of new features in WHMCS 7.6:
* Optimised user experience with promotions and upsells
* New and improved design and styling for client area and shopping cart promotions
* New sidebar promotion options for all MarketConnect services
* Native built-in translation support for translating and/or customising promotions and upsell messaging

=== Google reCaptcha ===
Google reCaptcha is now available for cart checkout. If enabled, the captcha input will replace the the Complete Checkout button until the challenge is met. For a completely seamless and nature experience, Invisible reCaptcha can be used. When using this option, the checkout button will appear as normal and the captcha challenge will be performed silently in the background for the visitor by Google's latest bot detection algorithms. [[Google reCAPTCHA|Learn More]]

== Deprecation & Removal Notices ==

During the v7.6.0 update, a one-time routine will inspect and attempt to the following modules due to discontinued service by the service provider. Removal will only occur if it is not actively in use. The Activity Log will have a list of any removals. As well, if removal is not performed and the module remains in your installation, an email will be generated for all full admins so that further investigation can be performed. Inspection will be performed for the following modules:
* DistributeIT
* GlobalSign OneClick SSL
* Amazon Simple Pay
* SecPay

== Library Updates ==

The following libraries have been updated
* phpmailer/phpmailer: 5.2.21 to 5.2.26
* smarty/smarty: 3.1.29 to 3.1.32
* tecnickcom/tcpdf: 6.2.12 to 6.2.17

The following libraries have been added
* phpseclib/mcrypt_compat: 1.0.5
* phpmyadmin/sql-parser: 4.2.4

== New Documentation ==

The following new documentation pages are available:

* [[WHMCS Domain Namespinning]]
* [[Domain Contact Verification]]
* [[Google reCAPTCHA]]
* [[MaxMind]]
* [[2CheckOut]]
* [[Font Awesome 5]]
* [https://marketplace.whmcs.com/help/connect/kb/overview/general/latest_news_and_updates Marketplace Updates and Improvements]
* [https://marketplace.whmcs.com/help/connect/kb/weebly_website_builder/getting_started/new_plans_weebly_lite_and_performance New Weebly Plans - Weebly Lite & Weebly Performance]

== Template Changes ==

For a list of changed files and graphical view of the exact changes, please refer to the Github repo's below.

=== Six Template ===

The following link provides a comparison of changes between 7.5.1 and 7.6.0:
https://github.com/WHMCS/templates-six/compare/v7.5.1-release.1...v7.6.0-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 7.5.1 and 7.6.0:
https://github.com/WHMCS/orderforms-standard_cart/compare/v7.5.1-release.1...v7.6.0-release.1

== Changelog ==
* [[Changelog:WHMCS_V7.6.0_Beta_1|Version 7.6.0 Beta 1]]
* [[Changelog:WHMCS_V7.6.0_RC_1|Version 7.6.0 RC 1]]
* [[Changelog:WHMCS_V7.6.0_GA|Version 7.6.0 General Availability]]

Health & Updates

2016-03-09T18:12:39Z

Artem:

The Health & Updates page provides an overview of the WHMCS installation and system environment status.

It will highlight any potential configuration or security related issues that may need your attention.

It also allows you to check if any updates are available for your currently installed WHMCS version, as well as providing quick and easy access to the Changelog and Release Notes for it.

==The Checks==

An overview of the checks performed and the purpose of each is provided below.

'''System Cron Tasks'''

Checks that the system cron has run to completion within the last 24 hours. If this reports a failure, it indicates that either the cron is not running (invalid cron command, file permissions, cron folder path, etc...) or that the cron is failing to complete successfully.

If this check reports a problem, you should begin by checking your cron command configuration and the activity log within WHMCS. For further assistance, please contact our support team.

'''Insecure Permissions Check'''

Ensures that key files and directories have appropriate permissions. Will alert you to ownership mismatches and/or permission levels that are higher than required for day-to-day operation of the system.

'''Required PHP Extensions'''

Checks for any PHP extensions required by WHMCS to operate and will alert you to any that are missing. Should any be reported as missing, you should recompile PHP with the missing extensions included.

'''Recommended PHP Extensions'''

Checks for the presence of recommended PHP extensions. While not strictly required, this will alert you to any extensions which are not available in your environment that are either required by certain addons/modules or that can help provide improved performance.

'''Required PHP Functions'''

Checks for any PHP functions that are required for WHMCS to operate and will alert you to any that are disabled. If you see any functions reported here, you should check for the presence of them in the ''php.ini'' configuration file '''disable_functions''' setting and remove them.

'''PHP Memory Limit'''

Checks the memory limit setting in your PHP environment and will alert you when it is too low. Will alert you by way of a failure level alert when below the minimum required value and a warning level alert when above the minimum but below the recommended value. For more details on the required memory limit, please refer to the [[System Requirements]] page.

'''Error Reporting'''

Alerts you if error reporting is enabled in your environment. While useful for development and debugging situations, in production, we strongly recommend having error reporting disabled for security reasons.

'''PHP Error Levels'''

Alerts you if the error reporting level is set to a very high level. We recommend only logging certain error types.

'''PHP Version'''

Checks your PHP Version. Will alert you if your current PHP version has reached End of Life and is no longer supported by the PHP Group.

'''Customising Default Paths'''

Checks for the existance of custom directory paths. You can customise some of the default directory paths in WHMCS to make it more difficult for malicious users to find them. This check will alert you if any directories that support customisation have not been customised.

'''Using Default Templates'''

Alerts you if any template settings are set to a template of a default name which could be an indication of customisations having been made to a default template. This can result in customisations being lost at the time of the next upgrade.

'''Installed cURL Version'''

Checks the installed curl version and alerts you if your version is known to have any vulnerabilities.

'''SSL Support in cURL'''

Checks to ensure that the curl library present in the PHP environment has SSL support which is required for normal WHMCS operation and many of the modules which come with WHMCS.

'''Database Collations'''

Checks if all database tables and columns use utf8_unicode_ci collation. This is recommended to ensure correct searching and sorting for all international characters.

'''PHP Session Support'''

Alerts you to any issues with the PHP Session configuration in your PHP environment.

'''Secure TLS Support in cURL'''

Checks to ensure that the curl library present in the PHP environment supports secure TLS versions (TLS v1.1 and v1.2). With many payment vendors phasing out legacy SSL/TLS protocols in accordance with PCI DSS recommendations, this check will help to stay up to date with newer standards.

Health & Updates

2016-03-09T18:07:06Z

Artem: