DocumentationCommerceConfiguration Guide

Production system setup

Last update: Fri Apr 21 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Admin
  • Developer

You can have one production system. All of the following must be true:

  • All Commerce code is in source control in the same repository as the development and build systems

  • Make sure all of the following are included in source control:

    • app/etc/config.php
    • generated directory (and subdirectories)
    • pub/media directory
    • pub/media/wysiwyg directory (and subdirectories)
    • pub/static directory (and subdirectories)

  • Commerce 2.2 or later must be installed and set for production mode

  • It has file system ownership and permissions set as discussed in Prerequisite for your development, build, and production systems.

Set up a production machine

To set up a production machine:

  1. After installing Commerce or pulling it from source control, log in to the production server as, or switch to, the file system owner.

  2. Create ~/.ssh/.composer/auth.json if you have not already done so.

    Create the directory:

    code language-bash 
    mkdir -p ~/.ssh/.composer

    Create auth.json in that directory.

    auth.json must contain your authentication keys.

    A sample follows:

    code language-json 
    {
   "http-basic": {
      "repo.magento.com": {
         "username": "<your public key>",
         "password": "<your private key>"
      }
   }
}

  3. Save your changes to auth.json.

  4. Copy <Commerce root dir>/app/etc/env.php from your development system to your production system.

  5. Open env.php in a text editor and change any values necessary (for example, database connection information).

  6. Run the magento config:set or magento config:set-sensitive command to set the values of any system-specific or sensitive configuration values, respectively.

    The following section shows an example.

Set configuration values on your production system

This section discusses how to set sensitive values on your production system using the magento config:sensitive:set command.

To set sensitive values:

  1. Find a value to set using the sensitive value reference.

  2. Note the configuration path for the setting.

  3. Log in to the production system as, or switch to, the file system owner.

  4. Change to the Commerce installation directory.

  5. Enter the following command:

    code language-bash 
    bin/magento config:sensitive:set {configuration path} {value}

    For example, to set the value of the YouTube API key to 1234, enter

    code language-bash 
    bin/magento config:sensitive:set catalog/product_video/youtube_api_key 1234

    You can also set one or more values interactively as follows:

    code language-bash 
    bin/magento config:sensitive:set -i

    When prompted, enter a value for each sensitive setting or press Enter to skip a value and move to the next one.

  6. To verify that the value was set, log in to the Admin.

  7. Locate the setting in the Admin.

    For example, the YouTube API key setting is located in Stores > Settings > Configuration > Catalog > Catalog > Product Video.

    The setting is displayed in the Admin and cannot be edited. The following figure shows an example.

    Sensitive setting in the Admin

recommendation-more-help
386822bd-e32c-40a8-81c2-ed90ad1e198c