Skip to content

Commit 65ec931

Browse files
author
Arthur Cinader
authored
Give steps to get compliant with deprecated AWS credential change. (#51)
* Give steps to get complient with deprecated AWS credential change. * change instructions to include S3_ACCESS_KEY S3_SECRET_KEY * fix typo * include section on how to still pass key and secret using overrides
1 parent 147e506 commit 65ec931

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,30 @@ parse-server adapter for AWS S3
1515
## Deprecation Notice -- AWS Credentials
1616
*the ability to explicitly pass credentials to this adapter is deprecated and will be removed in a future release.*
1717

18+
You may already be compatible with this change. If you have not explicitly set an `accessKey` and `secretKey` and you have configured the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, then you're all set and this will continue to work as is.
19+
20+
If you explicitly configured the environment variables `S3_ACCESS_KEY`
21+
`S3_SECRET_KEY`
22+
23+
*OR*
24+
25+
If you explicitly configured the `accessKey` and `secretKey` in your adapter configuration, then you'll need to...
26+
27+
For non AWS hosts:
28+
29+
* Run `aws configure` in a terminal which will step you through configuring credentials for the AWS SDK and CLI
30+
31+
For an AWS host:
32+
33+
* Ensure that the role that your host is running as has permissions for your s3 bucket
34+
35+
*Then*
36+
37+
* remove the `accessKey` and `secretKey` from your configuration
38+
39+
If for some reason you really need to be able to set the key and secret explicitly, you can still do it using `s3overrides` as described below and setting `accessKeyId` and `secretAccessKey` in the `s3Overrides` object.
40+
41+
# Deprecated Configuration
1842
Although it is not recommended, AWS credentials can be explicitly configured through an options
1943
object, constructor string arguments or environment variables ([see below](#using-a-config-file)).
2044
This option is provided for backward compatibility and will be removed in the forthcoming version 2.0 of this adapter.

0 commit comments

Comments
 (0)