WHMCS

https://docs.whmcs.com
Admin
WHMCS is an all-in-one client management, billing, and support platform for web hosting businesses...
Tokens:375,621
Snippets:7,922
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Execute Installation Script

Source: https://docs.whmcs.com/9-0/installation-guide/install-on-the-command-line

Pipes the configuration JSON to the installer script to initiate the installation process.

```bash
echo $(echo $CONF | tr -d "\n") | php -f bin/installer.php -- -i -n -c
```

--------------------------------

### Execute the installation script

Source: https://docs.whmcs.com/9-0/installation-guide/install-on-the-command-line

Run the WHMCS installer using the command-line interface with optional flags.

```bash
php -f bin/installer.php –- [options]
```

--------------------------------

### System Cron Execution Examples

Source: https://docs.whmcs.com/9-0/system/automation/system-cron

Examples of cron job configurations for running all tasks or skipping specific ones.

```bash
*/5 * * * * php -q /path/to/cron.php all
```

```bash
*/5 * * * * php -q /path/to/cron.php skip --DomainRenewalNotices
```

--------------------------------

### PHP Configuration Path Example

Source: https://docs.whmcs.com/9-0/troubleshooting/troubleshoot-email/php-mail/could-not-instantiate-errors

The typical location for the sendmail binary on Linux systems.

```text
/usr/sbin/sendmail
```

--------------------------------

### Example of a duplicated gateway module

Source: https://docs.whmcs.com/9-0/payments/payment-gateway-tutorials/copy-a-gateway-module

A complete example showing the renamed functions and updated configuration array for a new module named 'banktransfercopy'.

```php
<?php

# Bank Transfer Payment Gateway Module

function banktransfercopy_config() {
$configarray = array(
    "FriendlyName" => array(
        "Type" => "System",
        "Value" => "Bank Transfer Copy"
    ),
    "instructions" => array(
        "FriendlyName" => "Bank Transfer Instructions",
        "Type" => "textarea",
        "Rows" => "5",
        "Value" => "Bank Name:\nPayee Name:\nSort Code:\nAccount Number:",
        "Description" => "The instructions you want to display to customers who choose this payment method"
    ),
);

return $configarray;
}

function banktransfercopy_link($params) {
global $_LANG;

$code = '<p>' . nl2br($params['instructions']) . '<br />' . $_LANG['invoicerefnum'] . ': ' . $params['invoiceid'] . '</p>';

return $code;
}

?>
```

--------------------------------

### Example configuration.php File Content

Source: https://docs.whmcs.com/9-0/troubleshooting/troubleshoot-updates/no-existing-installation-errors

A sample structure for the configuration.php file, which must be present and readable for the upgrade process to proceed.

```php
<?php
$license = 'WHMCS-xxxxxxxxx';
$db_host = 'localhost';
$db_username = 'root';
$db_password = 'xxxxxxxx';
$db_name = 'whmcs';
$cc_encryption_hash = 'xxxxxxxxxxxxxxxxxxxxxxxxxx';
```

--------------------------------

### Identify ionCube Decoding Error

Source: https://docs.whmcs.com/9-0/troubleshooting/general-troubleshooting/file-cannot-be-decoded-errors

Example of the error message displayed when a file is incompatible with the installed ionCube Loader version.

```text
The file /home/username/public_html/path/to/whmcs/filename.php encoded as type [1/71] cannot be decoded by this version of the ionCube Loader. in Unknown on line 0
```

--------------------------------

### Constructing an Authentication Request URI

Source: https://docs.whmcs.com/9-0/system/authentication/openid-connect-development

Example of an HTTPS GET request URI used to initiate the OpenID Connect authentication flow with required parameters.

```text
https://www.example.com/whmcs/oauth/authorize.php?client_id=WHMCS-DEMO./hW6JgfqRfZ8eCCIsZHQTg==&response_type=code&scope=openid%20profile%20email&redirect_uri=https://oauth2-login-demo.example.com/code&state=security_token%3D138r5719ru3e1%26url%3Dhttps://oauth2-login-demo.example.com/index
```

--------------------------------

### Example Include Directive Output

Source: https://docs.whmcs.com/9-0/installation-guide/initial-configuration/restrict-nginx-directory-access

Sample output displaying multiple include files that may contain server directives.

```text
include /etc/nginx/modules-enabled/*.conf;
include /etc/nginx/mime.types;
include /etc/nginx/conf.d/*.conf;
include /etc/nginx/sites-enabled/*;
```

--------------------------------

### Remove Installation Directory

Source: https://docs.whmcs.com/9-0/system/updates/update-tutorials/update-on-the-command-line

Delete the installation directory after the update process is complete for security purposes.

```bash
rm -r /home/path/to/whmcs/install
```

--------------------------------

### Example System URL Format

Source: https://docs.whmcs.com/9-0/system/system-tutorials/update-the-system-url

The system URL must be an exact match, including the protocol and directory path.

```text
https://www.example.com/whmcs/
```

--------------------------------

### Initialize Override Language File

Source: https://docs.whmcs.com/9-0/system/localization/localization-tutorials/customize-text

Start every override file with the standard PHP opening tag.

```php
<?php
```

--------------------------------

### Accessing the WHMCS Installation Script

Source: https://docs.whmcs.com/9-0/installation-guide/install-whmcs

The URL path to access the installation script in a web browser.

```text
http://www.example.com/whmcs/install/install.php
```

--------------------------------

### Direct Link with Configurable Options

Source: https://docs.whmcs.com/9-0/clients/the-client-area/linking-to-whmcs

Example URL for pre-filling a configurable option value directly in the order link.

```text
http://example.com/whmcs/cart.php?a=add&pid=1&configoption[1]=100
```

--------------------------------

### Identify Installation Errors

Source: https://docs.whmcs.com/9-0/troubleshooting/troubleshoot-updates/no-existing-installation-errors

The error messages displayed when the upgrade process fails to locate a valid installation.

```text
no existing installation was detected
WHMCS Not Installed Error
```

--------------------------------

### Installation Error Message

Source: https://docs.whmcs.com/9-0/troubleshooting/troubleshoot-installation/duplicate-tblconfiguration-errors

The generic error message displayed on the install.php page when the installation process fails.

```text
Oops! Something went wrong and we couldn't process your request.
```

--------------------------------

### Example NGINX Configuration Test Output

Source: https://docs.whmcs.com/9-0/installation-guide/initial-configuration/restrict-nginx-directory-access

Sample output showing the location of the NGINX configuration file after running a test.

```text
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful
```

--------------------------------

### Example MarketConnect Tagline Override

Source: https://docs.whmcs.com/9-0/system/localization/localization-tutorials/customize-text

An example of overriding a specific tagline element for a GeoTrust upsell promotion.

```php
$_LANG['store']['geotrust']['upsell']['quickssl_premium_wildcard']['tagline'] = 'to protect your entire site in minutes.';
```

--------------------------------

### Example output of git fetch

Source: https://docs.whmcs.com/9-0/customization/client-area-customization-tutorials/update-customizations-with-git

This shows the expected output after running the git fetch command.

```text
remote: Counting objects: 96, done.
remote: Compressing objects: 100% (4/4), done.
remote: Total 96 (delta 67), reused 71 (delta 67), pack-reused 25
Unpacking objects: 100% (96/96), done.
From github.com/templates-twenty-one
  44d2e7c..7091cd0    master  -> origin/master
* [new tag]           v8.10.0-release.1 -> v8.10.0-release.1
* [new tag]           v8.10.0-rc.1 -> v8.10.0-rc.1
* [new tag]           v8.10.0-beta.1 -> v8.10.0-beta.1
```

--------------------------------

### Member Function Error Examples

Source: https://docs.whmcs.com/9-0/troubleshooting/troubleshoot-products-and-services/member-function-renewal-errors

Examples of common 'Call to a member function' errors encountered in the Client Area.

```text
Error: Call to a member function getOnDemandRenewalSettings() on null in /path/to/whmcs/vendor/whmcs/whmcs-foundation/lib/User/Client.php:0
```

```text
Error: Call to a member function enabledMetrics() on null in /path/to/whmcs/vendor/whmcs/whmcs-foundation/lib/Service/Service.php:0
```

--------------------------------

### Install ionCube via YUM

Source: https://docs.whmcs.com/9-0/installation-guide/install-ioncube-loader

Use the YUM package manager to install the ionCube loader for a specific PHP version.

```bash
yum install ea-phpYY-php-ioncubeXX
```

--------------------------------

### Create a configuration.php file

Source: https://docs.whmcs.com/9-0/installation-guide/install-on-the-command-line

Manually define database and license variables in the configuration.php file located in the main WHMCS directory.

```php
<?php
$license = "";
$db_host = "localhost";
$db_username = "";
$db_password = "";
$db_name = "";
$cc_encryption_hash = "";
$templates_compiledir = "templates_c/";
```

--------------------------------

### Configure MySQL SSL via CLI Installation

Source: https://docs.whmcs.com/9-0/system/database-and-storage/database-and-storage-tutorials/encrypt-your-mysql-connection

Include these lines in the JSON input when using the --config option during CLI installation.

```json
"db_tls_ca":"'/path/to/ca/file'",
"db_tls_ca_path":"'/path/to/ca/directory'",
"db_tls_cert":"'/path/to/client/cert'",
"db_tls_cipher":"'AES256-SHA'",
"db_tls_key":"'/path/to/client/key'",
"db_tls_verify_cert":"'0'",
```

--------------------------------

### CSV Import File Example

Source: https://docs.whmcs.com/9-0/addon-modules/importassist

A sample CSV file demonstrating the required headers and data format for client imports.

```csv
id,uuid,first_name,last_name,company_name,tax_id,email,address_1,address_2,city,state,postcode,country,phone,currency_id,default_payment_method,credit_balance,tax_exempt,late_fee_override,override_due_notices,separate_invoices,disable_auto_cc,client_group_id,language,notes,status,password_hash,email_opt_out,override_auto_close,date_created
1,99faaefe-611f-4e55-b22f-29bdfe3a2d2c,Cassidy,Walker,"Example Hosting Co.",GB-224477999,c.walker@example.com,"1234 Street St",,Anytown,TX,12345,US,555-123-4567,1,,7.30,0,0,0,0,2,0,english,"Imported from file",Inactive,$2y$10$oTRoIuHQcG/23sIQ0cCDy.Jk1qswUQVzwsCvHb2cT8W/fkoYqXasq,0,2,2025-09-15
2,ac22b046-46ef-4b8c-990d-c5e2b2a7a111,Ivy,Smith,"Example Websites, Inc.",GB-18799999,ivy.smith@example.net,"5678 Avenue Ave",,Cityville,CA,54321,US,555-543-2198,1,,12.50,0,0,0,1,1,1,french,"Imported from file",Active,$2y$10$abc123XYZ4h1aMqWV3q9tseSqHg9M87Z1kXJLDUEOUK9umeyCYfR1y,0,1,2025-10-22
3,7bdc7e0d-2bfb-49c7-ae2e-8768b5adf347,Jeremiah,Robertson,"Example Enterprises",GB-12344321,jeremiah.robertson@example.tv,"9101 Road Rd",,Townsville,IL,12345,US,555-123-4578,1,,0.00,0,0,0,0,1,2,spanish,"Imported from file",Closed,$2y$10$3wJXIhuwwq2p5F1zOfdS5Ozzrv5JmsLJnHqsDlDUji7zyxPVKMd7y,0,0,2025-09-08
4,c1a59b6a-3a34-4b81-9d73-b1a3a3f17a28,Aria,Nguyen,"Example Services",GB-99999999,aria.nguyen@example.org,"1112 Boulevard Blvd",Suite 12,Sample City,NY,54321,US,555-543-1234,2,,5.75,0,1,0,1,2,0,german,"Imported from file",Inactive,$2y$10$Yk4TlCgAx7liumvF0Osp3.RKpzGQJYoTV4/CC7goGk3OGrF42b21y,0,1,2025-11-03
5,8dc3d8d7-9c6b-4cd7-a8e7-6d3d2c52a1c4,Blake,Ramirez,"Example Solutions",GB-22551199,blake.r@example.co,"1314 Lane Ln",Apt 3B,Demo Town,WA,12345,US,555-321-4567,3,,2.20,0,0,0,0,0,2,english,"Imported from file",Closed,$2y$10$OdxkhtVX8/uaB2qguzrif.tkGXnaq9JAaiRAbLw6M78ahDHMCgY0q,0,2,2025-11-12
```

--------------------------------

### Authorized JavaScript Origins Configuration Example

Source: https://docs.whmcs.com/9-0/troubleshooting/troubleshoot-authentication/invalid-details-errors

Example of the required format for the Authorized JavaScript Origins setting based on the WHMCS System URL.

```text
https://example.com
```
Tokens:
Raw