Skip to content

Commit faa9897

Browse files
j-musialm-mohr
andauthored
clarify the usage of S3 credentials (#38)
* clarify the usage of S3 credentials * Update README.md * Update README.md --------- Co-authored-by: Matthias Mohr <[email protected]>
1 parent bc04e02 commit faa9897

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,24 @@ Planetary Computer uses the same signed URL pattern described above. Here is an
348348
}
349349
}
350350
```
351+
352+
### Simple S3 authentication
353+
354+
To use simple S3 authentication one has to set some environmental variables with S3 credentials:
355+
356+
- `AWS_SECRET_ACCESS_KEY`
357+
- `AWS_ACCESS_KEY_ID`
358+
359+
**or** specify a [user profile](https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-files.html#cli-configure-files-format)
360+
with a proper reference to `AWS_PROFILE` in the file `AWS_CONFIG_FILE`.
361+
362+
For more information please see either
363+
[GDAL vsis3](https://gdal.org/en/latest/user/virtual_file_systems.html#vsis3-aws-s3-files) or
364+
[AWS CLI](https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-files.html) documentation.
365+
366+
Additionally, if the `s3` authentication method is referred to through `auth:refs`, you should disable signing requests,
367+
e.g. through setting `AWS_NO_SIGN_REQUEST` to `NO`. Otherwise it should be `YES`.
368+
351369
## Contributing
352370

353371
All contributions are subject to the

0 commit comments

Comments
 (0)