From bfa10c244eb704aa2880d70466fd71ced3e0d5dc Mon Sep 17 00:00:00 2001 From: Dominik Matic Date: Wed, 12 Mar 2025 13:55:39 +0100 Subject: [PATCH 1/3] Add clarity and more information to the magento 2 command section for setting up object storage --- ...onfigure-remote-storage-for-magento-2-x.md | 22 +++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md b/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md index 3a528896..6bad0d3c 100644 --- a/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md +++ b/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md @@ -32,30 +32,44 @@ bin/magento setup:config:set \ --remote-storage-bucket="my_bucket_name" \ --remote-storage-region="provider-region" \ --remote-storage-key="abcd1234" \ - --remote-storage-secret="abcd1234" \ + --remote-storage-secret="1234abcd" \ --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: +In the case of Hypernode Object Storage, the bucket name is `main`, and the region is `EU`. The other remaining parameters you can get by running `hypernode-object-storage info` with the `--with-credentials` flag: ```console 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 | +| 12345678-9012-3456-b7e3-19ab43df4a23 | testappbucket1 | OS200GB | testapp | https://example.ams.objectstore.eu | abcd1234 | 1234abcd | +--------------------------------------+----------------+---------+-------------+-------------------------------------+---------------+---------------+ ``` +So, in that case, the command would look like this: + +```bash +bin/magento setup:config:set \ + --remote-storage-driver="aws-s3" \ + --remote-storage-bucket="main" \ + --remote-storage-region="EU" \ + --remote-storage-key="abcd1234" \ + --remote-storage-secret="1234abcd" \ + --remote-storage-endpoint="https://example.ams.objectstore.eu" +``` + **AWS S3** +If you have an AWS S3 bucket, the command is somewhat simpler, you just need to know what your bucket name is, your aws region and your aws access and secret key. + ```bash 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" + --remote-storage-secret="1234abcd" ``` ## Syncing the files (efficiently) From 7d21fa6bd89f0d64e10933e9fb7c6b755809cbef Mon Sep 17 00:00:00 2001 From: Dominik Matic Date: Thu, 13 Mar 2025 10:39:16 +0100 Subject: [PATCH 2/3] improvements --- ...configure-remote-storage-for-magento-2-x.md | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md b/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md index 6bad0d3c..ca301865 100644 --- a/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md +++ b/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md @@ -29,14 +29,14 @@ If you're using Hypernode Object Storage or a different provider than AWS S3, yo ```bash bin/magento setup:config:set \ --remote-storage-driver="aws-s3" \ - --remote-storage-bucket="my_bucket_name" \ - --remote-storage-region="provider-region" \ + --remote-storage-bucket="main" \ + --remote-storage-region="EU" \ --remote-storage-key="abcd1234" \ --remote-storage-secret="1234abcd" \ --remote-storage-endpoint="https://my-s3-compatible.endpoint.com" ``` -In the case of Hypernode Object Storage, the bucket name is `main`, and the region is `EU`. The other remaining parameters you can get by running `hypernode-object-storage info` with the `--with-credentials` flag: +For Hypernode Object Storage, use `main` as the bucket name and `EU` as the region. You can retrieve the remaining parameters by running `hypernode-object-storage info --with-credentials`. ```console app@testapp ~ # hypernode-object-storage info --with-credentials @@ -47,17 +47,7 @@ app@testapp ~ # hypernode-object-storage info --with-credentials +--------------------------------------+----------------+---------+-------------+-------------------------------------+---------------+---------------+ ``` -So, in that case, the command would look like this: - -```bash -bin/magento setup:config:set \ - --remote-storage-driver="aws-s3" \ - --remote-storage-bucket="main" \ - --remote-storage-region="EU" \ - --remote-storage-key="abcd1234" \ - --remote-storage-secret="1234abcd" \ - --remote-storage-endpoint="https://example.ams.objectstore.eu" -``` +If you're using a different object storage provider, replace these values with the relevant details from your provider. **AWS S3** From 4095efe5ba6ac3c9a00b7628ba68b72c0a7da374 Mon Sep 17 00:00:00 2001 From: Dominik Matic Date: Thu, 13 Mar 2025 10:43:36 +0100 Subject: [PATCH 3/3] fix aws sentence --- .../how-to-configure-remote-storage-for-magento-2-x.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md b/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md index ca301865..43efdd47 100644 --- a/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md +++ b/docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md @@ -51,7 +51,7 @@ If you're using a different object storage provider, replace these values with t **AWS S3** -If you have an AWS S3 bucket, the command is somewhat simpler, you just need to know what your bucket name is, your aws region and your aws access and secret key. +If you're using an AWS S3 bucket, you only need your bucket name, AWS region, and access and secret keys. ```bash bin/magento setup:config:set \