Update setup:install command to include Elasticsearch flags

src/guides/v2.4/install-gde/install/cli/install-cli-install.md

@@ -0,0 +1,286 @@
+---
+group: installation-guide
+subgroup: 05_Command-line installation
+title: Install the Magento software
+menu_title: Install the Magento software
+menu_order: 4
+functional_areas:
+  - Install
+  - System
+  - Setup
+---
+
+{:.bs-callout-tip}
+Totally lost? Need a helping hand? Try our [installation quick reference (tutorial)]({{ page.baseurl }}/install-gde/install-quick-ref.html) or [installation roadmap (reference)]({{ page.baseurl }}/install-gde/install-roadmap_part1.html).
+
+## Before you start your installation {#instgde-install-cli-prereq}
+
+Before you begin, complete the following steps:
+
+*  Verify that your system meets the requirements discussed in [Magento system requirements]({{ page.baseurl }}/install-gde/system-requirements.html).
+
+*  Complete all [prerequisite]({{ page.baseurl }}/install-gde/prereq/prereq-overview.html) tasks.
+
+*  Complete the first installation steps. See [Your install or upgrade path]({{ page.baseurl }}/install-gde/bk-install-guide.html).
+
+*  After you log in to the Magento server, [switch to the Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html).
+
+*  Review the [Get started with the command-line installation]({{ page.baseurl }}/install-gde/install/cli/install-cli-subcommands.html) overview.
+
+ {:.bs-callout-info}
+You must install Magento from its `bin` subdirectory.
+
+You can run the installer multiple times with different options to complete installation tasks like the following:
+
+*  Install in phases—For example, after you configure your web server for Secure Sockets Layer (SSL), you can run the installer again to set SSL options.
+
+*  Correct mistakes in previous installations.
+
+*  Install Magento in a different database instance.
+
+ {:.bs-callout-info}
+By default, the installer does not overwrite the Magento database if you install the Magento software in the same database instance. You can use the optional `cleanup-database` parameter to change this behavior.
+
+See also [Update, reinstall, uninstall]({{ page.baseurl }}/install-gde/install/cli/install-cli-uninstall.html).
+
+{% include install/fully-secure.md %}
+
+## Installer help commands {#instgde-cli-help-cmds}
+
+You can run the following commands to find values for some required arguments:
+
+| Installer argument | Command                         |
+| ------------------ | ------------------------------- |
+| Language           | magento info:language:list      |
+| Currency           | magento info:currency:list      |
+| Time zone          | php  magento info:timezone:list |
+
+ {:.bs-callout-info}
+If an error displays when you run these commands, verify that you updated installation dependencies as discussed in [Update installation dependencies]({{ page.baseurl }}/install-gde/install/prepare-install.html).
+
+## Install the Magento software from the command line {#instgde-install-cli-magento}
+
+The install command uses the following format:
+
+```bash
+magento setup:install --<option>=<value> ... --<option>=<value>
+```
+
+The following tables describe the installation option names and values. For example installation commands. see [Sample localhost installations](#install-cli-example).
+
+{:.bs-callout-info}
+Any options that contain spaces or special characters must be enclosed in either single or double quotes.
+
+**Admin credentials:**
+
+The following options specify the user information and credentials for the Magento admin user.
+
+In Magento Commerce version 2.2.8 and later, you can create the Magento admin user during or after installation. If you create the user during installation, all admin credential variables are required. See [Sample localhost installations](#install-cli-example).
+
+|Name|Value|Required?|
+|--- |--- |--- |
+|`--admin-firstname`|Magento administrator user's first name.|Yes|
+|`--admin-lastname`|Magento administrator user's last name.|Yes|
+|`--admin-email`|Magento administrator user's e-mail address.|Yes|
+|`--admin-user`|Magento administrator username.|Yes|
+|`--admin-password`|Magento administrator user password. The password must be at least 7 characters in length and must include at least one alphabetic and at least one numeric character. We recommend a longer, more complex password. Enclose the entire password string in single quotes. For example, `--admin-password='A0b9%t3g'`|Yes|
+
+**Site and database configuration options:**
+
+|Name|Value|Required?|
+|--- |--- |--- |
+|`--base-url`|Base URL to use to access your Magento Admin and storefront in any of the following formats:<br><br>`http[s]://<host or ip>/<your Magento install dir>/`.<br><br>**Note:** The scheme (http:// or https://) and a trailing slash are both required.<br><br>`<your Magento install dir>` is the docroot-relative path in which to install the Magento software. Depending on how you set up your web server and virtual hosts, the path might be magento2 or it might be blank.<br><br>To access Magento on localhost, you can use either `http://127.0.0.1/<your Magento install dir>/` or `http://127.0.0.1/<your Magento install dir>/`.<br><br>- `{{base_url}}` which represents a base URL defined by a virtual host setting or by a virtualization environment like Docker. For example, if you set up a virtual host for Magento with the hostname magento.example.com, you can install the Magento software with `--base-url={{base_url}}` and access the Magento Admin with a URL like http://magento.example.com/admin.|Yes|
+|`--backend-frontname`|Uniform Resource Identifier (URI) to access the Magento Admin. You can omit this parameter to let Magento generate a random URI for you with the following pattern <code>admin_jkhgdfq</code>.<br><br>We recommend a random URI for security purposes. A random URI is harder for hackers or malicious software to exploit.<br><br>The URI displays at the end of the installation. You can display it later at any time using the magento info:adminuri command.<br><br>If you choose to enter a value, we recommend you not use a common word like admin, backend, and so on. The Admin URI can contain alphanumeric values and the underscore character (`_`) only.|No|
+|`--db-host`|Use any of the following:<br><br>- The database server's fully qualified hostname or IP address.<br><br>- `localhost` (default) or `127.0.0.1` if your database server is on the same host as your web server.localhost means the MySQL client library uses UNIX sockets to connect to the database. `127.0.0.1` causes the client library to use the TCP protocol. For more information about sockets, see the [PHP PDO_MYSQL documentation](http://php.net/manual/en/ref.pdo-mysql.php).<br><br>**Note:** You can optionally specify the database server port in its hostname like www.example.com:9000|Yes|
+|`--db-name`|Name of the Magento database instance in which you want to install the Magento database tables.<br><br>Default is `magento2`.|Yes|
+|`--db-user`|Username of the Magento database instance owner.<br><br>Default is `root`.|Yes|
+|`--db-password`|Magento database instance owner's password.|Yes|
+|`--db-prefix`|Use only if you're installing the Magento database tables in a database instance that has Magento tables in it already.<br><br>In that case, use a prefix to identify the Magento tables for this installation. Some customers have more than one Magento instance running on a server with all tables in the same database.<br><br>The prefix can be a maximum of five characters in length. It must begin with a letter and can include only letters, numbers, and underscore characters.<br><br>This option enables those customers to share the database server with more than one Magento installation.|No|
+|`--db-ssl-key`|Path to the client key.|No|
+|`--db-ssl-cert`|Path to the client certificate.|No|
+|`--db-ssl-ca`|Path to the server certificate.|No|
+|`--language`|Language code to use in the Admin and storefront. (If you have not done so already, you can view the list of language codes by entering magento info:language:list from the bin directory.)|No|
+|`--currency`|Default currency to use in the storefront. (If you have not done so already, you can view the list of currencies by entering magento info:currency:list from the bin directory.)|No|
+|`--timezone`|Default time zone to use in the Admin and storefront. (If you have not done so already, you can view the list of time zones by entering magento info:timezone:list from the bin directory.)|No|
+|`--use-rewrites`|`1` means you use web server rewrites for generated links in the storefront and Admin.<br><br>`0` disables the use of web server rewrites. This is the default.|No|
+|`--use-secure`|`1` enables the use of Secure Sockets Layer (SSL) in storefront URLs. Make sure your web server supports SSL before you select this option.<br><br>`0` disables the use of SSL with Magento. In this case, all other secure URL options are assumed to also be 0. This is the default.|No|
+|`--base-url-secure`|Secure base URL to use to access your Magento Admin and storefront in the following format: `http[s]://<host or ip>/<your Magento install dir>/`|No|
+|`--use-secure-admin`|`1` means you use SSL to access the Magento Admin. Make sure your web server supports SSL before you select this option.<br><br>`0` means you do not use SSL with the Admin. This is the default.|No|
+|`--admin-use-security-key`|1 causes the Magento software to use a randomly generated key value to access pages in the Magento Admin and in forms. These key values help prevent cross-site script forgery attacks. This is the default.<br><br>`0` disables the use of the key.|No|
+|`--session-save`|Use any of the following:<br><br>- `db` to store session data in the database. Choose database storage if you have a clustered database; otherwise, there might not be much benefit over file-based storage.<br><br>- `files` to store session data in the file system. File-based session storage is appropriate unless the Magento file system access is slow, you have a clustered database, or you want to store session data in Redis.<br><br>- `redis` to store session data in Redis. If you will be using Redis for default or page caching, Redis must be already installed. See Use Redis for session storage for additional information about configuring support for Redis.|No|
+|`--key`|If you have one, specify a key to encrypt sensitive data in the Magento database. If you don't have one, Magento generates one for you.|Yes|
+|`--cleanup-database`|To drop database tables before installing the Magento software, specify this parameter without a value. Otherwise, the Magento database is left intact.|No|
+|`--db-init-statements`|Advanced MySQL configuration parameter. Uses database initialization statements to run when connecting to the MySQL database. Consult a reference similar to this one before you set any values.<br><br>Default is `SET NAMES utf8;`.|No|
+|`--sales-order-increment-prefix`|Specify a string value to use as a prefix for sales orders. Typically, this is used to guarantee unique order numbers for payment processors.|No|
+
+**Elasticsearch configuration options:**
+
+|Name|Value|Required?|
+|--- |--- |--- |
+`--search-engine` | The version of Elasticsearch to use as the search engine. Possible values are `elasticsearch5`, `elasticsearch6`, and `elasticsearch7`. The default is `elasticsearch7` | No
+`--elasticsearch-host` | The host name or IP address where Elasticsearch is running. The default is `localhost`. | No
+`--elasticsearch-port` | The port for incoming HTTP requests. The default is `9200`. | No
+`--elasticsearch-index-prefix` | A prefix that identifies the Elasticsearch index. The default is `magento2`. | No
+`--elasticsearch-timeout` | The number of seconds before the system times out. The default is `15`. | No
+`--elasticsearch-enable-auth` | Enables authentication on the Elasticsearch server. The default is `false`. | No
+`--elasticsearch-username` | The user ID to authenticate Elasticsearch | No, unless authentication is enabled
+`--elasticsearch-password` | The password to authenticate Elasticsearch | No, unless authentication is enabled
+
+**RabbitMQ configuration options:**
+
+|Name|Value|Required?|
+|--- |--- |--- |
+|`--amqp-host`|Do not use the `--amqp` options unless you have already set up an installation of RabbitMQ. See RabbitMQ installation for more information about installing and configuring RabbitMQ.<br><br>The hostname where RabbitMQ is installed.|No|
+|`--amqp-port`|The port to use to connect to RabbitMQ. The default is 5672.|No|
+|`--amqp-user`|The username for connecting to RabbitMQ. Do not use the default user `guest`.|No|
+|`--amqp-password`|The password for connecting to RabbitMQ. Do not use the default password `guest`.|No|
+|`--amqp-virtualhost`|The virtual host for connecting to RabbitMQ. The default is `/`.|No|
+|`--amqp-ssl`|Indicates whether to connect to RabbitMQ. The default is `false`. See RabbitMQ for information about setting up SSL for RabbitMQ.|No|
+|`--consumers-wait-for-messages`|Should consumers wait for a message from the queue? 1 - Yes, 0 - No|No|
+
+**Lock configuration options:**
+
+|Name|Value|Required?|
+|--- |--- |--- |
+|`--lock-provider`|Lock provider name.<br><br>Available lock providers: `db`, `zookeeper`, `file`.<br><br>The default lock provider: `db`|No|
+|`--lock-db-prefix`|The specific db prefix to avoid lock conflicts when using `db` lock provider.<br><br>The default value: `NULL`|No|
+|`--lock-zookeeper-host`|Host and port to connect to Zookeeper cluster when you use `zookeeper` lock provider.<br><br>For example: `127.0.0.1:2181`|Yes, if you set `--lock-provider=zookeeper`|
+|`--lock-zookeeper-path`|The path where Zookeeper will save locks.<br><br>The default path is: `/magento/locks`|No|
+|`--lock-file-path`|The path where file locks will be saved.|Yes, if you set `--lock-provider=file`|
+{:style="table-layout:auto;"}
+
+**Consumers configuration options:**
+
+{% include config/consumers.md %}
+
+{:.bs-callout-info}
+To enable or disable modules after installing Magento, see [Enable and disable modules]({{ page.baseurl }}/install-gde/install/cli/install-cli-subcommands-enable.html).
+
+{% include install/sens-data.md %}
+
+### Sample localhost installations {#install-cli-example}
+
+The following examples show the commands to complete install {{ site.data.var.ee }} locally with various options.
+
+#### Example 1—Basic installation with admin user account
+
+The following example installs Magento with the following options:
+
+*  The Magento software is installed in the `magento2` directory relative to the web server docroot on `localhost` and the path to the Magento Admin is `admin`; therefore:
+
+   Your storefront URL is `http://127.0.0.1`
+
+*  The database server is on the same host as the web server.
+
+   The database name is `magento`, and the username and password are both `magento`
+
+*  Uses server rewrites
+
+*  The Magento administrator has the following properties:
+
+   *  First and last name are `Magento User`
+   *  Username is `admin` and the password is `admin123`
+   *  E-mail address is `user@example.com`
+
+*  Default language is `en_US` (U.S. English)
+*  Default currency is U.S. dollars
+*  Default time zone is U.S. Central (America/Chicago)
+
+```bash
+magento setup:install --base-url=http://127.0.0.1/magento2/ \
+--db-host=localhost --db-name=magento --db-user=magento --db-password=magento \
+--admin-firstname=Magento --admin-lastname=User --admin-email=user@example.com \
+--admin-user=admin --admin-password=admin123 --language=en_US \
+--currency=USD --timezone=America/Chicago --use-rewrites=1
+```
+
+Messages similar to the following display to indicate a successful installation:
+
+```terminal
+Post installation file permissions check...
+For security, remove write permissions from these directories: '/var/www/html/magento2/app/etc'
+[Progress: 274 / 274]
+[SUCCESS]: Magento installation complete.
+[SUCCESS]: Admin Panel URI: /admin_puu71q
+```
+
+#### Example 2— Basic install without admin user account
+
+In {{ site.data.var.ee }} version 2.2.8 and later, you have the option to install Magento without creating the Magento administrator user as shown in the following example.
+
+```bash
+magento setup:install --base-url=http://127.0.0.1/magento2/ \
+--db-host=localhost --db-name=magento --db-user=magento --db-password=magento \
+--language=en_US --currency=USD --timezone=America/Chicago --use-rewrites=1
+```
+
+Messages like the following display if the installation is successful:
+
+```terminal
+Post installation file permissions check...
+For security, remove write permissions from these directories: '/var/www/html/magento2/app/etc'
+[Progress: 274 / 274]
+[SUCCESS]: Magento installation complete.
+[SUCCESS]: Admin Panel URI: /admin_puu71q
+```
+
+After installation you can create an admin user using the `admin:user:create` command:
+[Create or edit an administrator]({{ page.baseurl }}/install-gde/install/cli/install-cli-subcommands-admin.html#create-or-edit-an-administrator)
+
+#### Example 3—Install with additional options
+
+The following example installs Magento with the following options:
+
+*  The Magento software is installed in the `magento2` directory relative to the web server docroot on `localhost` and the path to the Magento Admin is `admin`; therefore:
+
+   Your storefront URL is `http://127.0.0.1`
+
+*  The database server is on the same host as the web server.
+
+   The database name is `magento`, and the username and password are both `magento`
+
+*  The Magento administrator has the following properties:
+
+   *  First and last name are `Magento User`
+   *  Username is `admin` and the password is `admin123`
+   *  E-mail address is `user@example.com`
+
+*  Default language is `en_US` (U.S. English)
+*  Default currency is U.S. dollars
+*  Default time zone is U.S. Central (America/Chicago)
+*  The installer first cleans up the database before installing the tables and schema
+*  You use a sales order increment prefix `ORD$` and because it contains a special character (`$`), the value must be enclosed in double quotes
+*  Session data is saved in the database
+*  Uses server rewrites
+
+```bash
+magento setup:install --base-url=http://127.0.0.1/magento2/ \
+--db-host=localhost --db-name=magento \
+--db-user=magento --db-password=magento \
+--admin-firstname=Magento --admin-lastname=User --admin-email=user@example.com \
+--admin-user=admin --admin-password=admin123 --language=en_US \
+--currency=USD --timezone=America/Chicago --cleanup-database \
+--sales-order-increment-prefix="ORD$" --session-save=db --use-rewrites=1
+```
+
+{:.bs-callout .bs-callout-info}
+You must enter the command either on a single line or, as in the preceding example, with a `\` character at the end of each line.
+
+Messages like the following display if the installation is successful:
+
+```terminal
+Post installation file permissions check...
+For security, remove write permissions from these directories: '/var/www/html/magento2/app/etc'
+[Progress: 274 / 274]
+[SUCCESS]: Magento installation complete.
+[SUCCESS]: Admin Panel URI: /admin_puu71q
+```
+
+{:.ref-header}
+Related topics
+
+*  If you have one user account to access the Magento server, see [Optionally set a umask]({{ page.baseurl }}/install-gde/install/post-install-umask.html).
+
+   This type of setup is typical for shared hosting.
+
+*  [Verify the installation]({{ page.baseurl }}/install-gde/install/verify.html).