Connect to a remote environment

You can connect to a remote environment using the magento-cloud CLI or an SSH command. The magento-cloud CLI commands can only be used in Starter and Pro integration environments.

Use the Cloud CLI

To log in to a remote integration environment:

  1. On your local workstation, change to your project directory.

  2. List the environments in that project.

    magento-cloud environment:list -p <project-ID>
    
  3. Use SSH to log in to the remote environment.

    magento-cloud ssh -p <project-ID> -e <environment-ID>
    

Use an SSH command

The Cloud Console includes a list of Web and SSH access commands for each environment.

To copy the SSH command:

  1. Log in to the Cloud Console.

  2. Select a project from the All projects list.

  3. Select an environment.

  4. Click SSH.

  5. In the SSH tab, click the copy button to copy the full SSH command to the clipboard.

  6. Open a terminal and paste the SSH command to create a connection.

    ssh abcdefg123abc-branch-a12b34c--mymagento@ssh.us-2.magento.cloud
    
TIP
For Pro Staging and Production environments, the SSH command may look like:
ssh <node>.ent-<project-ID>-<environment>-<user-ID>@ssh.<region>.magento.com

sFTP

Adobe Commerce on cloud infrastructure supports accessing your environments using sFTP (secure FTP) with SSH authentication. Use a client that supports SSH key authentication for sFTP and use your public SSH key. Your public SSH key must be added to the target environment. For Starter environments and Pro integration environments, you can add it through the Cloud Console.

Read-only sFTP connections are not supported; sFTP access is provided with write permission by default.

When configuring sFTP, use the information from your SSH access environment command: <project-id>-<environment-id>--<app-name>@ssh<cloud-host>

  • Username: All content before the @ in your SSH access destination.
  • Password: You do not need a password for sFTP. sFTP access uses the SSH key authentication.
  • Host: All content after the @ in your SSH access.
  • Port: 22, which is the default SSH port.
  • SSH Private Key: If necessary, provide the location of your private key to the sFTP client. By default, private keys are stored in the ~/.ssh directory.

Depending on the client, additional options may be required to complete SSH authentication for sFTP. Review the documentation for your selected client.

For Starter environments and Pro integration environments, you may also want to consider adding a mount for access to a specific directory. You would add the mount to your .magento.app.yaml file. For a list of writable directories, see Project structure. This mount point only works in those environments.

For Pro Staging and Production environments, if you do not have SSH access to the environment, you must submit an Adobe Commerce Support ticket to request sFTP access and a mount point for access to the specific folder, e.g., pub/media.

NOTE
For Pro Staging and Production, if the sFTP connection is for a generic user that does not need to be added to the Cloud project, you must submit an Adobe Commerce Support ticket with their public key attached. Never provide your private SSH key.