[PaaS only]{class="badge informative" title="Applies to Adobe Commerce on Cloud projects (Adobe-managed PaaS infrastructure) and on-premises projects only."}

Admin variables

Users that have administrative access to the Adobe Commerce on cloud infrastructure project can use the following project environment variables to override the configuration settings for the administrative user account to access the Admin UI.

Admin credentials

You can override Admin user credentials during Commerce installation with the ADMIN variables in the following table.

If you want to change the values after installation, connect to your environment using SSH and use the Adobe Commerce CLI admin:user command to create or edit the Admin user credentials.

Variable
Default
Description
ADMIN_USERNAME
License Owner email address
A username for the administrative user with the ability to create other users, including administrative users.
ADMIN_EMAIL
Email address for the administrative user. This address is used to send password reset notifications.
ADMIN_PASSWORD
Password for the administrative user. When the project is created, a random password is generated and an email is sent to the License Owner. During project creation, the License Owner should have already changed the password. Contact the License Owner for the updated password.
ADMIN_LOCALE
en_US
The default locale used by the Admin.

Admin URL

Use the following environment variable to secure access to your Admin UI. If specified, this value overrides the default URL during installation. In Adobe Commerce on cloud infrastructure, you must set or change the Admin URL using the ADMIN_URL variable in the (Cloud Console or Cloud CLI). Modifying the setting from the Admin is only applicable for on-premises installations.

ADMIN_URL—The relative URL to access the Admin UI. The default URL is /admin.

Change the Admin URL

By default, the Commerce Admin URL is set to <domain_name>/admin. For security reasons, Adobe recommends changing it to a unique, custom Admin URL that is not easy to guess.

In Adobe Commerce on cloud infrastructure, you must change the Admin URL using the ADMIN_URL environment variable in the (Cloud Console or Cloud CLI). Modifying the setting from the Admin is only applicable for on-premises installations. For on-premises installations, follow use a custom admin URL.

Adobe recommends changing the environment-level variable for the Admin URL after installation. Configure this setting for security reasons before branching from the cloned master environment. All branches created from the master branch inherit the environment-level variables and their values unless you set inheritance to false.

Use either the Cloud Console or the Cloud CLI to set or update ADMIN_URL.

Option A: Change the Admin URL using the Cloud Console

Integration environment

From the Cloud Console, add a new variable with:

Set the Admin URL in the Cloud Console
  1. Log in to the Cloud Console.

  2. Select a project from the All projects list.

  3. In the project overview, select the environment and click the configuration icon.

  4. Select the Variables tab.

  5. Click Create Variable (or edit the existing ADMIN_URL variable if present).

  6. Enter the following:

    • Variable name: ADMIN_URL
    • Value: Your new Admin path (for example, magento_A8v10).

    By default, Available during runtime and Make inheritable are selected. To prevent child environments from inheriting this value, clear Make inheritable for this variable.

  7. Click Create variable (or Save) and wait until deployment completes. The button is only visible when the required fields contain values.

When Staging and Production are not available in the Cloud Console

Submit a support ticket requesting to add the ADMIN_URL variable for your Staging or Production environment. If Staging and Production are accessible from the Cloud Console, add the variable as described in Integration environment.

Option B: Change the Admin URL using the Cloud CLI

Use the magento-cloud variable:update command to update the variable. (The variable:set command has been deprecated and is not available.)

The following example updates the master environment ADMIN_URL to newAdmin_A8v10 and prevents child environments from inheriting the value:

magento-cloud variable:update ADMIN_URL --value newAdmin_A8v10 -e master --inheritable false
  • Redeployment: Changing the ADMIN_URL variable in the Cloud CLI triggers a redeployment of the environment.
  • Inheritance: Variables are inheritable by default. To prevent the value from being inherited by child environments, use the --inheritable false option as shown. For more detail, see variable level visibility.
NOTE
The ADMIN_URL value accepts letters (a–z, A–Z), numbers (0–9), and the underscore character (_). Spaces or other characters are not accepted.
recommendation-more-help
7c2b03ac-000c-497d-aba3-2c6dc720a938