Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify the usage of S3 credentials #38

Merged
merged 3 commits into from
Dec 4, 2024
Merged

clarify the usage of S3 credentials #38

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5125ec4
clarify the usage of S3 credentials
j-musial Nov 24, 2024
6214967
Update README.md
m-mohr Nov 24, 2024
3b96506
Update README.md
m-mohr Nov 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,24 @@ 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** 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.

m-mohr marked this conversation as resolved.
Show resolved Hide resolved
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
Expand Down