From 579cf771e59347a5892f5bfbcb23eedd0d34b529 Mon Sep 17 00:00:00 2001 From: wn_ Date: Sat, 3 Dec 2022 13:27:25 +0000 Subject: Use the AWS PHP SDK's default credential provider chain. This allows for use of any supported approach, in particular AWS IAM instance profiles, to provide credentials. If used, access and secret key environment variables will need to be changed to the expected names (i.e. 'TTRSS_CACHE_S3_ACCESS_KEY' to 'AWS_ACCESS_KEY_ID' and 'CACHE_S3_SECRET_KEY' to 'AWS_SECRET_ACCESS_KEY'). --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2a1a54d..b8e68d7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Cache S3 -File cache backend using S3 protocol (e.g. Minio) +File cache backend using S3 protocol (e.g. Minio, AWS S3). ## Installation @@ -14,6 +14,13 @@ The following options are required: TTRSS_CACHE_S3_ENDPOINT=http://example.com:9000 TTRSS_CACHE_S3_BUCKET=bucket-name TTRSS_CACHE_S3_REGION=us-east-1 -TTRSS_CACHE_S3_ACCESS_KEY=xxx -TTRSS_CACHE_S3_SECRET_KEY=yyy +``` + +The following options are required if you're directly providing access keys (i.e. not using an IAM role or alternative approach). +See [Credentials for the AWS SDK for PHP Version 3](https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html) for more information. + +```ini +# Intentionally without the 'TTRSS_' prefix. +AWS_ACCESS_KEY_ID=xxx +AWS_SECRET_ACCESS_KEY=yyy ``` -- cgit v1.2.3 From 09b07d59ef5175ac084b39e9d99eed9900813a45 Mon Sep 17 00:00:00 2001 From: wn_ Date: Sat, 3 Dec 2022 14:02:59 +0000 Subject: Switch back to plugin-specific access key env vars. --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b8e68d7..78e4e40 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,6 @@ The following options are required if you're directly providing access keys (i.e See [Credentials for the AWS SDK for PHP Version 3](https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html) for more information. ```ini -# Intentionally without the 'TTRSS_' prefix. -AWS_ACCESS_KEY_ID=xxx -AWS_SECRET_ACCESS_KEY=yyy +TTRSS_CACHE_S3_ACCESS_KEY=xxx +TTRSS_CACHE_S3_SECRET_KEY=yyy ``` -- cgit v1.2.3