Skip to content

Commit

Permalink
clarify the usage of S3 credentials (#38)
Browse files Browse the repository at this point in the history
* clarify the usage of S3 credentials

* Update README.md

* Update README.md

---------

Co-authored-by: Matthias Mohr <[email protected]>
  • Loading branch information
j-musial and m-mohr authored Dec 4, 2024
1 parent bc04e02 commit faa9897
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
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.

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

0 comments on commit faa9897

Please sign in to comment.