Install On The Command Line - Revision history

SarahK: /* Installing from the command line */

2023-08-28T17:13:59Z

‎Installing from the command line

SarahK at 18:06, 27 July 2023

2023-07-27T18:06:59Z

SarahK: /* Options */

2020-05-04T16:26:01Z

‎Options

SarahK: /* Example installation with configuration data */

2020-05-04T14:10:05Z

‎Example installation with configuration data

SarahK: /* Example installation with configuration data */

2020-05-04T14:09:44Z

‎Example installation with configuration data

SarahK: /* Supplying configuration data */

2020-05-04T14:08:39Z

‎Supplying configuration data

SarahK: /* Options */

2020-05-04T13:56:30Z

‎Options

SarahK at 13:01, 4 May 2020

2020-05-04T13:01:29Z

SarahK at 13:00, 4 May 2020

2020-05-04T13:00:17Z

SarahK at 12:47, 4 May 2020

2020-05-04T12:47:05Z

@@ Line 2: / Line 2: @@
 <div class="docs-alert-warning">
-WHMCS 8.8 and later include optional configuration settings for encrypted MySQL connections. For more information, see [[System Environment Guide]] and [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].
+WHMCS 8.8 and later include configuration settings for encrypted MySQL connections. For more information, see [[System Environment Guide]] and [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].
 </div>

← Older revision		Revision as of 18:06, 27 July 2023
Line 1:		Line 1:
	=== Installing from the command line ===		=== Installing from the command line ===
		+
		+	<div class="docs-alert-warning">
		+	WHMCS 8.8 and later include optional configuration settings for encrypted MySQL connections. For more information, see [[System Environment Guide]] and [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].
		+	</div>

	In addition to our [[Installing_WHMCS\|other methods]], you can install and upgrade WHMCS on the command line. This is useful when you provision WHMCS for multiple installations. To use this method of installation, you must first download the <tt>.zip</tt> file for the desired version of WHMCS and unzip it.		In addition to our [[Installing_WHMCS\|other methods]], you can install and upgrade WHMCS on the command line. This is useful when you provision WHMCS for multiple installations. To use this method of installation, you must first download the <tt>.zip</tt> file for the desired version of WHMCS and unzip it.

@@ Line 40: / Line 40: @@
 <td>Perform a new installation.</td>
 </tr><tr>
-<td><tt>-n</tt> or <tt>--non-interactive</tt></td>
+<td valign="top" style="white-space:nowrap">
 <td>Don't require user input while the script runs.</td>
 </tr><tr>

@@ Line 109: / Line 109: @@
 <div class="source-cli">
-<br/>echo $(echo $CONF | tr -d "\n") | php -f bin/installer.php – -i -n -c
+echo $(echo $CONF | tr -d "\n") | php -f bin/installer.php – -i -n -c
 </div>

@@ Line 82: / Line 82: @@
 ===== <span id="ex-config"></span>Example installation with configuration data =====
 <div class="source-cli">
@@ Line 102: / Line 104: @@
 <br/>&nbsp;}
 <br/>}'
-<br/>
+</div>
 <br/>echo $(echo $CONF | tr -d "\n") | php -f bin/installer.php – -i -n -c
 </div>

@@ Line 69: / Line 69: @@
 <td><tt>configuration</tt></td>
 <td>Provide variable data for the creation of a new configuration file. For a list of parameters to use, see our documentation on [[Restoring_WHMCS#Creating_a_New_Configuration_File|creating a new configuration file for WHMCS]].
+* The system creates a <tt>configuration.php</tt> file when your input contains the <tt>configuration</tt> element.
 For an example of installation using this element, see the [[#ex-config|Example installation with configuration data]] section below.</td>
 </tr>
 </table>
 <div class="docs-alert-warning">

@@ Line 24: / Line 24: @@
 You can use these options with the installation script:
-{| class="wikitable"
+<table class="table table-striped table-condensed">
-!  Option
+<tr>
-!  Description
+<th>Option</th>
-|-
+<th>Description</th>
-|  <tt>-c</tt> or <tt>--config</tt>
+</tr><tr>
-|   Provide configuration data in the JSON format. Use this with the <tt>-n</tt> or <tt>--non-interactive</tt> option.
+<td><tt>-c</tt> or <tt>--config</tt></td>
 For more on how to use this, see [[#data|Supplying configuration data]] below.
-<div class="docs-alert-warning"><span class="title">Added in WHMCS 7.10</span><br />We added this option in WHMCS version 7.10.</div>
+<div class="docs-alert-warning"><span class="title">Added in WHMCS 7.10</span><br />We added this option in WHMCS version 7.10.</div></td>
-|-
+</tr><tr>
-|  <tt>-h</tt> or <tt>--help</tt>
+<td><tt>-h</tt> or <tt>--help</tt></td>
-|   View help information.
+<td>View help information.</td>
-|-
+</tr><tr>
-|  <tt>-i</tt> or <tt>--install</tt>
+<td><tt>-i</tt> or <tt>--install</tt></td>
-|   Perform a new installation.
+<td>Perform a new installation.</td>
-|-
+</tr><tr>
-|  <tt>-n</tt> or <tt>--non-interactive</tt>
+<td><tt>-n</tt> or <tt>--non-interactive</tt></td>
-|   Don't require user input while the script runs.
+<td>Don't require user input while the script runs.</td>
-|-
+</tr><tr>
-|  <tt>-s</tt> or <tt>--status</tt>
+<td><tt>-s</tt> or <tt>--status</tt></td>
-|   Provide status information about the installation's files and databases.
+<td>Provide status information about the installation's files and databases.</td>
-|-
+</tr><tr>
-|  <tt>-u</tt> or <tt>--upgrade</tt>
+<td><tt>-u</tt> or <tt>--upgrade</tt></td>
-|   Upgrade an existing installation.
+<td>Upgrade an existing installation.</td>
-|-
+</tr><tr>
-|  <tt>-v</tt> or <tt>--verbose</tt>
+<td><tt>-v</tt> or <tt>--verbose</tt></td>
-|   Run the script with verbose output.
+<td>Run the script with verbose output.</td>
-|}
+</tr>
 ==== <span id="data"></span>Supplying configuration data ====
@@ Line 58: / Line 60: @@
 You can supply data for two elements:
-{| class="wikitable"
+<table class="table table-striped table-condensed">
-!  Array
+<tr><th>Array</th>
-!  Description
+<th>Description</th>
-|-
+</tr><tr>
-|  <tt>admin</tt>
+<td><tt>admin</tt></td>
-|   Provide information for the initial administrator account using the <tt>username</tt> and <tt>password</tt> parameters. If you don't supply these, the system generates and displays them at the end of installation.
+<td>Provide information for the initial administrator account using the <tt>username</tt> and <tt>password</tt> parameters. If you don't supply these, the system generates and displays them at the end of installation.</td>
-|-
+</tr><tr>
-|  <tt>configuration</tt>
+<td><tt>configuration</tt></td>
-| Provide variable data for the creation of a new configuration file. For a list of parameters to use, see our documentation on [[Restoring_WHMCS#Creating_a_New_Configuration_File|creating a new configuration file for WHMCS]].
+<td>Provide variable data for the creation of a new configuration file. For a list of parameters to use, see our documentation on [[Restoring_WHMCS#Creating_a_New_Configuration_File|creating a new configuration file for WHMCS]].
-For an example of installation using this element, see the [[#ex-config|Example installation with configuration data]] section below.
+For an example of installation using this element, see the [[#ex-config|Example installation with configuration data]] section below.</td>
-|}
+</tr>
 * The system creates a <tt>configuration.php</tt> file when your input contains the <tt>configuration</tt> element.

@@ Line 79: / Line 79: @@
 <div class="docs-alert-warning">
 <span class="title">Warning</span><br />
-Exercise caution using the <tt>admin</tt> array to supply passwords. It could pose a security risk.
+Exercise caution when you supply sensitive information on the command line.
 </div>

@@ Line 5: / Line 5: @@
 <div class="docs-alert-warning">
 <span class="title">For advanced users</span><br />
-* We only recommend this method for advanced users who are familiar with database management and the command line.
+* We only recommend this method for advanced users who are familiar with WHMCS, database management, and the command line.
-* Configuration and database issues can prevent you from using this method. We recommend that you perform a backup first.
+* Configuration and database issues can prevent you from using this method. Always create file and database backups before you use this method.
-* This installation method doesn't perform checks for [[Installing_WHMCS|InnoDB or database setup]].
+* This installation method doesn't perform [[Installing_WHMCS|system requirement]] checks.
 </div>
@@ Line 54: / Line 54: @@
 ==== <span id="data"></span>Supplying configuration data ====
-If you use the <tt>-c</tt> or <tt>--config</tt> option, you must supply configuration data in the JSON format. For example:
+If you use the <tt>-c</tt> or <tt>--config</tt> option, you must supply configuration data to STDIN as a single line of input in the JSON format.
-<div class="source-cli">
+You can supply data for two elements:
 {| class="wikitable"
@@ Line 69: / Line 63: @@
 |-
 |  <tt>admin</tt>
-|   Provide information for the installation's administrator account using the <tt>username</tt> and <tt>password</tt> parameters.
+|   Provide information for the initial administrator account using the <tt>username</tt> and <tt>password</tt> parameters. If you don't supply these, the system generates and displays them at the end of installation.
 <div class="docs-alert-warning">
 <span class="title">Warning</span><br />
 Exercise caution using the <tt>admin</tt> array to supply passwords. It could pose a security risk.
 </div>
-|-
-|  <tt>configuration</tt>
+===== <span id="ex-config"></span>Example installation with configuration data =====
-| Provide configuration information for the WHMCS installation.  For a list of parameters to use, see [[Restoring_WHMCS#Creating_a_New_Configuration_File|Restoring WHMCS]].
-|}
+<div class="source-cli">