Important

You are browsing documentation for version 5.0 of OroCommerce, supported until January 2025. Read the documentation for version 6.0 (the latest LTS version) to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Before You Begin 

If you plan to deploy a custom version of Oro application that is hosted in a custom private repository, please, do the following:

  • Share the repository URL with the OroCloud Support Team

  • Authorize access to your custom repository for the ssh key you have taken from Oro Support Team

Connect to the OroCloud Environment via VPN 

You will get the OroCloud access information – server IP address, username, and the .ovpn configuration file.

You can use OpenVPN to create a VPN tunnel to the OroCloud. First, install the OpenVPN client to your Windows, Linux, or Mac OS. Once the client is installed:

  1. Open the configuration file you were provided via the OpenVPN client. This will load the connection configuration.

  2. Right-click the OpenVPN client in the system tray and click Connect OroCloud.

Once the connection is established, you can access your OroCloud environment via SSH connection to the host you were provided. Use your personalized user details to log on to the server.

Connect to the OroCloud Environment via SSH 

Configure password and SSH key using SSH Access and connect to VPN.

There are multiple ways to connect using SSH:

  1. Use IP address and username provided by Oro Support Team.

  2. Get IP address from Google Cloud Console

Note

Connection using SSH button (using external IP) is now allowed.

  1. Use gcloud CLI tool to list VMs gcloud compute instances list and connect gcloud compute ssh ocom-yourproject-prod1-maint1 –internal-ip to VMs.

Connect to the OroCloud Environment via SFTP 

SFTP is the secure file transfer protocol which is the extension of the SSH protocol. It provides a way to transfer large amounts of data from the client to the target host anywhere on the Internet. OroCloud provides the ability to connect to the OroCommerce instance and upload data (e.g., media) on customer request using SFTP service.

Request SFTP Access 

To get SFTP access to your OroCloud instance, create a ticket in the support portal. This ticket must contain the following information:

  • The exact instance definition, such as staging, production, etc.

  • An email of the person who will use this SFTP account.

  • A username for the account and/or your public SSH key for the SFTP account

  • A list of IPs from which the connection to the SFTP is allowed

Note

OroCloud supports both “username+password” and SSH key authentication for SFTP.

Once access is granted, the support team will update the ticket with the IP address of the SFTP server. The password for the newly created account will be sent to the email provided in the ticket.

Connect to the SFTP Server 

Once you have received the SFTP server IP and password, you can connect to the OroCloud using an SFTP client of your choice.

Here are a few tips for troubleshooting of the problems when establishing connection to your SFTP server:

  • Ensure that you are connecting from the allowed IP address. In other words, your IP address must be present on the list of IPs in the ticket that you created to request SFTP access. You can test connectivity using telnet command telnet yoursftpIP:22.

  • Ensure that the username and password pair you are using is correct. The username is the same as the one provided in the ticket that you created to request SFTP access and the password is available in the email. Do not use an email address as your user name.

  • In case you are using a key for authentication, check if your SFTP clients are configured to use the correct key.

Manage Uploaded Data 

Important

Please do not change subfolders’ permissions using either SFTP client or application PHP code, all subfolders must be created only via SFTP client.

Once you uploaded data to you SFTP directory, you may need to move it to the destination location on your website. OroCloud maintenance agent supports the media:upload command for data transfer between your SFTP directory and your OroCommerce website. You can find a detailed description and usage examples in the Media Upload section of the OroCloud guide.

Developers can allow the application to read / write directly from the SFTP directory using the environment variable defined in parameters.yml(.dist) or config.yml:

parameters:
    sftp_root_path: '%env(ORO_SFTP_ROOT_PATH)%'
    env(ORO_SFTP_ROOT_PATH): null

You can use it as any other parameter but remember to add a specific path to your user, i.e:

my_service:
  class: Oro\Bundle\Acme\Service
  arguments:
    - '%sftp_root_path%/myusername/uploads'

Use Images Uploaded via SFTP in Import via CSV 

The parameters.yml file has the following configuration:

gaufrette_adapter.import_files: /mnt/sftproot

Usually, one or several users have access to sftp, and each of them may upload data to their own directory (username). Therefor, set [username]/image.jpg as the import data path to an image in a CSV file, where image.jpg is a picture uploaded by a username user.