Skip to content

how-to-configure-remote-storage-for-magento-2-x.md

Latest commit

 

History

History
123 lines (91 loc) · 5.37 KB

how-to-configure-remote-storage-for-magento-2-x.md

File metadata and controls

123 lines (91 loc) · 5.37 KB
myst
html_meta
description title
Configure remote storage for Magento 2.x. Learn how to configure Magento 2 to start storing files in your bucket using a single command.
How to Configure Remote Storage for Magento 2.x | Hypernode

How to Configure Remote Storage for Magento 2.x

Magento 2.x supports remote storage for media files, import/export files, and other files. This feature allows you to store files in a remote storage location, such as an Amazon S3 bucket, instead of storing them on the server itself.

This can be useful for many reasons, such as:

  • Offloading storage from your server, reducing the load on your server, and improving performance.
  • Allows you to make use of horizontal scaling, as you can easily add more servers without having to worry about syncing files between them.
  • Allows for effortless storage capacity scaling, as you can easily increase the storage capacity of your remote storage location.
  • Serving assets from a CDN, which can improve the performance of your website.

Configuring the application

Configuring Magento 2 to start storing files in your bucket is done using a single command.

Hypernode Object Storage and other S3 compatible providers

If you're using Hypernode Object Storage or a different provider than AWS S3, you need to specify the --remote-storage-endpoint option.

bin/magento setup:config:set \
    --remote-storage-driver="aws-s3" \
    --remote-storage-bucket="my_bucket_name" \
    --remote-storage-region="provider-region" \
    --remote-storage-key="abcd1234" \
    --remote-storage-secret="abcd1234" \
    --remote-storage-endpoint="https://my-s3-compatible.endpoint.com"

In the case of Hypernode Object Storage you can get the relevant information by running hypernode-object-storage info with the --with-credentials flag:

app@testapp ~ # hypernode-object-storage info --with-credentials
+--------------------------------------+----------------+---------+-------------+-------------------------------------+---------------+---------------+
|                 UUID                 |      Name      |   Plan  |  Hypernodes |           Management URL            |   Access Key  |   Secret Key  |
+--------------------------------------+----------------+---------+-------------+-------------------------------------+---------------+---------------+
| 12345678-9012-3456-b7e3-19ab43df4a23 | testappbucket1 | OS200GB |   testapp   |  https://example.ams.objectstore.eu |   abcd1234    |   abcd1234    |
+--------------------------------------+----------------+---------+-------------+-------------------------------------+---------------+---------------+

AWS S3

bin/magento setup:config:set \
    --remote-storage-driver="aws-s3" \
    --remote-storage-bucket="my_bucket_name" \
    --remote-storage-region="my-aws-region" \
    --remote-storage-key="abcd1234" \
    --remote-storage-secret="abcd1234"

Syncing the files (efficiently)

Magento provides an official method for syncing files using the following command (not recommended):

bin/magento remote-storage:sync

However, for better performance, you can use the following alternative:

hypernode-object-storage objects sync pub/media/ s3://my_bucket_name/media/
hypernode-object-storage objects sync var/import_export s3://my_bucket_name/import_export

The hypernode-object-storage objects sync command runs the sync process in the background and provides the Process ID (PID). You can monitor the sync progress using:

hypernode-object-storage objects show PID

Alternatively, you can use the AWS CLI directly:

aws s3 sync pub/media/ s3://my_bucket_name/media/
aws s3 sync var/import_export s3://my_bucket_name/import_export

Both methods are significantly faster than Magento’s built-in sync, as aws s3 sync handles uploads concurrently.

The storage flag file in the bucket

Magento's S3 implementation creates a test file called storage.flag, which is basically created to test if the connection works. So this is not a magic file to mark anything (source).

Serving assets from your S3 bucket

To serve media assets directly from your S3 bucket, you need to adjust your nginx configuration. Fortunately, hypernode-manage-vhosts (simplifies this process for you).

Configuring Amazon S3 bucket policies

If you’re using Amazon S3, ensure that your S3 bucket policies are properly configured so that only the /media directory is publicly accessible. For example:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowPublicReadOnlyForMedia",
      "Effect": "Allow",
      "Principal": "*",
      "Action": "s3:GetObject",
      "Resource": "arn:aws:s3:::<your-bucket-name>/media/*"
    }
  ]
}

Magento remote storage documentation