Skip to content

Commit 8ca06e4

Browse files
authored
Apply suggestions from code review
1 parent 614017a commit 8ca06e4

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

platforms/aws-s3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ This defines the Amazon Web Services (AWS) S3 interface.
77
- `bucket`: The bucket name.
88
- `region`: One of the S3 regions (lowercase).
99

10-
**Note:** If `s3` exists in `auth:refs`, you should use sign requests,
10+
**Note:** If the `s3` authentication scheme (i.e. "Simple S3 authentication") is referred to through `auth:refs`, you should disable signing requests,
1111
e.g. using the AWS CLI parameter `--no-sign-request`.

platforms/custom-s3.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ GDAL documentation: <https://gdal.org/en/latest/user/virtual_file_systems.html#v
1414

1515
- `platform`: Some options for S3 can be inferred from the given URL (template):
1616
- `AWS_HTTPS` can be retrieved by parsing the scheme part of the URL. `https` = `ON`, `http` = `OFF`.
17-
- `AWS_S3_ENDPOINT` is the authority part of the URL after replacing all variables in the URL.
17+
- `AWS_S3_ENDPOINT` is the authority part of the URL after replacing all variables in the URL, e.g. `us-west.mycloud.com` without `https://` or `s3://` as prefix.
1818
- `AWS_VIRTUAL_HOSTING` must be set to `FALSE` if there's no `{bucket}` placeholder in the URL template, otherwise `TRUE` (default value).
1919
- The `region` property corresponds to the `AWS_REGION` option.
2020
- The `requester_pays` property corresponds to the `AWS_REQUEST_PAYER` option. If `requester_pays` is `true`, set `AWS_REQUEST_PAYER` to `requester`.
21-
- If `s3` exists in `auth:refs`, you should set `AWS_NO_SIGN_REQUEST` to `YES`. Otherwise it should be `NO`.
21+
- If the `s3` authentication scheme (i.e. "Simple S3 authentication") is referred to through `auth:refs`,
22+
you should set `AWS_NO_SIGN_REQUEST` to `NO`. Otherwise it should be `YES`.
2223

2324
### AWS CLI
2425

@@ -35,4 +36,5 @@ s3cmd documentation: <https://s3tools.org/usage>
3536
- `platform` corresponds to `--host` / `--host-bucket` after replacing all variables in the URL (?).
3637
- `region` corresponds to `--region`.
3738
- `requester_pays` corresponds to `--requester-pays`.
38-
- If `s3` exists in `auth:refs`, you should use the `s3cmd sign` command.
39+
- If the `s3` authentication scheme (i.e. "Simple S3 authentication") is referred to through `auth:refs`,
40+
you should provide an secret access key and an access key id through environment variables, a profile or the `s3cmd sign` command.

0 commit comments

Comments
 (0)