System Environment Guide - Revision history

JoshQ: Add steps to resolve "Could not connect to database" error for Encrypted Database Connections

2024-02-22T15:15:52Z

Add steps to resolve "Could not connect to database" error for Encrypted Database Connections

JuanR: /* Database Privileges */

2024-01-03T13:48:51Z

‎Database Privileges

SarahK: /* Encrypted Database Connections */

2023-09-01T13:38:12Z

‎Encrypted Database Connections

SarahK: /* Encrypted Database Connections */

2023-08-31T22:12:16Z

‎Encrypted Database Connections

SarahK: /* Encrypted Database Connections */

2023-08-28T17:13:31Z

‎Encrypted Database Connections

Lawrence: /* Required */

2023-08-08T11:58:04Z

‎Required

Lawrence: /* Recommended */

2023-08-08T11:55:37Z

‎Recommended

SarahK: /* Database */

2023-07-27T18:11:09Z

‎Database

James.white: /* Required */

2023-06-20T06:40:19Z

‎Required

Lawrence: /* Recommended */

2023-06-07T14:53:56Z

‎Recommended

← Older revision		Revision as of 15:15, 22 February 2024
Line 83:		Line 83:

	You can configure these variables before, during, or after installation using the [[Install On The Command Line\|command-line installation method]] or after installation using the [[Installing WHMCS\|browser-based installation method]]. For steps, see [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].		You can configure these variables before, during, or after installation using the [[Install On The Command Line\|command-line installation method]] or after installation using the [[Installing WHMCS\|browser-based installation method]]. For steps, see [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].
		+
		+	<div class="docs-alert-warning">
		+	If you set <tt>db_tls_verify_cert</tt> to <tt>1</tt> (enabled), the <tt>db_host</tt> value in the <tt>configuration.php</tt> file '''must''' match the Common Name (CN) or be a Subject Alternative Name (SAN) of the certificate that you specify for <tt>db_tls_cert</tt>.
		+
		+	If the hostname does not match and <tt>db_tls_verify_cert</tt> is enabled, you will see a <tt>Could not connect to database</tt> error. To resolve this issue, set <tt>db_tls_verify_cert</tt> to <tt>0</tt> or provide a new certificate with a CN or SAN that matches the <tt>db_host</tt> value.
		+	</div>

	<div class="docs-alert-info">		<div class="docs-alert-info">

@@ Line 49: / Line 49: @@
 === Database Privileges ===
-When installing or updating WHMCS, or when activating or deactivating modules, the following privileges are required:
+When installing or updating WHMCS, activating or deactivating modules, or resetting the '''Module Log''' entries at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''', you must grant the following privileges:
 * ALTER
 * CREATE

@@ Line 84: / Line 84: @@
 You can configure these variables before, during, or after installation using the [[Install On The Command Line|command-line installation method]] or after installation using the [[Installing WHMCS|browser-based installation method]]. For steps, see [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].
-<div class="docs-alert-info">For steps to configure encrypted MySQL connections on cPanel & WHM servers, see [https://docs.cpanel.net/knowledge-base/security/how-to-configure-mysql-ssl-connections/ cPanel's How to Configure MySQL SSL Connections Documentation].</div>
+<div class="docs-alert-info">
 == PHP ==

← Older revision		Revision as of 22:12, 31 August 2023
Line 83:		Line 83:

	You can configure these variables before, during, or after installation using the [[Install On The Command Line\|command-line installation method]] or after installation using the [[Installing WHMCS\|browser-based installation method]]. For steps, see [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].		You can configure these variables before, during, or after installation using the [[Install On The Command Line\|command-line installation method]] or after installation using the [[Installing WHMCS\|browser-based installation method]]. For steps, see [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].
		+
		+	<div class="docs-alert-info">For steps to configure encrypted MySQL connections on cPanel & WHM servers, see [https://docs.cpanel.net/knowledge-base/security/how-to-configure-mysql-ssl-connections/ cPanel's How to Configure MySQL SSL Connections Documentation].</div>

	== PHP ==		== PHP ==

@@ Line 71: / Line 71: @@
 === Encrypted Database Connections ===
-<div class="docs-alert-info"> We added this support in WHMCS 8.8.</div>
+<div class="docs-alert-info">We added this support in WHMCS 8.8.</div>
-Support for encrypted MySQL connections requires adding configuration variables to the <tt>configuration.php</tt> file. You can use the following variables:
+Support for encrypted MySQL connections uses the following configuration variables in the <tt>configuration.php</tt> file:
-* <tt>db_tls_ca</tt> — The path to the CA .pem file (for example, <tt>/var/www/html/whmcs/ca.pem</tt>).
+* <tt>db_tls_ca</tt> — The path to the CA <tt>.pem</tt> file (for example, <tt>/var/www/html/whmcs/ca.pem</tt>).
 * <tt>db_tls_ca_path</tt> — The path to the directory that contains the CA certificate files.
 * <tt>db_tls_cert</tt> — The path to the client's certificate.
@@ Line 82: / Line 82: @@
 * <tt>db_tls_verify_cert</tt> — Disable (<tt>0</tt>) or enable (<tt>1</tt>) the server certificate.
-You can add these variables before, during, or after installation using the [[Install On The Command Line|command-line installation method]] or after installation using the [[Installing WHMCS|browser-based installation method]]. For steps, see [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].
+You can configure these variables before, during, or after installation using the [[Install On The Command Line|command-line installation method]] or after installation using the [[Installing WHMCS|browser-based installation method]]. For steps, see [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].
 == PHP ==

@@ Line 103: / Line 103: @@
 ==== Required ====
 ; cURL with SSL Support
 : cURL is used when interacting with APIs of external systems such as the WHMCS Licensing & Update servers, payment gateways, servers that host your products, etc.  cURL's SSL support must be enabled so that verified and encrypted communication is possible.
@@ Line 112: / Line 108: @@
 ; GD2
 : GD2 Image Library is used when performing graphic manipulation, such as image thumbnails and PDFs.
 ;Reflection
 : Reflection adds the ability to examine and identify classes, interfaces, functions, methods, and extensions within your application. As part of this, the extension can check also for and retrieve documented comments within the same classes, interfaces, functions, and methods.
 ; XML
 : WHMCS uses the SimpleXML extension that PHP compiles by default. It is highly used for communication with remote systems, such as registrars, payment gateways, and servers.
 ==== Recommended ====

@@ Line 126: / Line 126: @@
 ==== Recommended ====
 ; Intl
 : Intl performs character inspection and transformation, such as in IDN to perform Punycode conversions and transliterations. While we provide a third party dependency to compensate for the absence of Intl, it is much more performant to have the actual extension in the environment.
 ; mbstring
 : The mbstring extension is for multi-byte character support, i.e managing non-Latin characters and glyphs.  If available, this extension provides significant performance, allows for broader support of characters and glyphs common throughout digital communications, and is highly recommended.
 ; OpenSSL
 : OpenSSL is for secure communications and random number generation.  If available, this extension will be used and provide significant performance improvements for cryptographic routines.
 === PHP INI Settings ===

@@ Line 68: / Line 68: @@
 If you are developing code for the WHMCS platform, it is recommended that you interact with the database via the [https://developers.whmcs.com/api/internal-api/ Local API], [https://developers.whmcs.com/advanced/db-interaction/ DBAL & ORM], or [[Using Models|Models]].  All three methods will abstract database connection details and system compatibility for you and will be supported by WHMCS for the foreseeable future.  The [https://docs.whmcs.com/SQL_Helper_Functions?redirect=no SQL Helper Functions] are still present, although deprecated.  Due to their ubiquitous usage, we anticipate supporting them as long as possible but recommend that you use one of the other methods above.  You can learn more at [https://developers.whmcs.com/advanced/db-interaction/ Interacting with the Database] on our developer's site.
 <div id="PHP_Version"> </div>
 == PHP ==
 WHMCS is written in PHP.  Your environment's PHP will need to be a version supported by the version of WHMCS you are using.  In general, this will be one of the PHP versions that is either under active development or is receiving security fixes from the upstream PHP maintainers.

@@ Line 107: / Line 107: @@
 ==== Recommended ====
 ; iconv
 : The iconv extension is for character set conversion, i.e. managing different non-latin characters. If available, this extension provides significant performance improvements and is highly recommended.