From 5125ec44fe3783bc6a7e9e3115e8238e749dadf3 Mon Sep 17 00:00:00 2001 From: Jan Musial Date: Sun, 24 Nov 2024 17:04:41 +0100 Subject: [PATCH 1/3] clarify the usage of S3 credentials --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 91eebc2..8ab391e 100644 --- a/README.md +++ b/README.md @@ -348,6 +348,17 @@ Planetary Computer uses the same signed URL pattern described above. Here is an } } ``` +### Simple S3 authentication +To use simple S3 authentication one has to set some environmental variables with S3 credentials: + +```AWS_SECRET_ACCESS_KEY``` +```AWS_ACCESS_KEY_ID``` + +or to specify: + +[user profile](https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-files.html#cli-configure-files-format) with a proper reference to ```AWS_PROFILE``` in the file ```AWS_CONFIG_FILE```. For more info please visit [GDAL vsis3 documentation](https://gdal.org/en/latest/user/virtual_file_systems.html#vsis3-aws-s3-files). + + ## Contributing All contributions are subject to the From 621496731d0d9bebcd0d90f75d0581504e7a7746 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Sun, 24 Nov 2024 19:43:53 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8ab391e..3f0062b 100644 --- a/README.md +++ b/README.md @@ -348,16 +348,20 @@ Planetary Computer uses the same signed URL pattern described above. Here is an } } ``` + ### Simple S3 authentication -To use simple S3 authentication one has to set some environmental variables with S3 credentials: -```AWS_SECRET_ACCESS_KEY``` -```AWS_ACCESS_KEY_ID``` +To use simple S3 authentication one has to set some environmental variables with S3 credentials: -or to specify: +- `AWS_SECRET_ACCESS_KEY` +- `AWS_ACCESS_KEY_ID` -[user profile](https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-files.html#cli-configure-files-format) with a proper reference to ```AWS_PROFILE``` in the file ```AWS_CONFIG_FILE```. For more info please visit [GDAL vsis3 documentation](https://gdal.org/en/latest/user/virtual_file_systems.html#vsis3-aws-s3-files). +**or** specify a [user profile](https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-files.html#cli-configure-files-format) +with a proper reference to `AWS_PROFILE` in the file `AWS_CONFIG_FILE`. +For more information please see either +[GDAL vsis3](https://gdal.org/en/latest/user/virtual_file_systems.html#vsis3-aws-s3-files) or +[AWS CLI](https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-files.html) documentation. ## Contributing From 3b96506b0d9a57cded77a11283c6f2d09bc1a386 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Sun, 24 Nov 2024 20:01:19 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3f0062b..96dd8c1 100644 --- a/README.md +++ b/README.md @@ -363,6 +363,9 @@ For more information please see either [GDAL vsis3](https://gdal.org/en/latest/user/virtual_file_systems.html#vsis3-aws-s3-files) or [AWS CLI](https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-files.html) documentation. +Additionally, if the `s3` authentication method is referred to through `auth:refs`, you should disable signing requests, +e.g. through setting `AWS_NO_SIGN_REQUEST` to `NO`. Otherwise it should be `YES`. + ## Contributing All contributions are subject to the