Skip to content

Commit d54d83a

Browse files
authored
Document new config for s3 assume role external ID (#2)
1 parent 676c6d4 commit d54d83a

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

docs/configuration/options.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -420,6 +420,8 @@ imgproxy can process files from Amazon S3 buckets, but this feature is disabled
420420
* [`IMGPROXY_S3_ENDPOINT`]: a custom S3 endpoint to being used by imgproxy
421421
* [`IMGPROXY_S3_MULTI_REGION`]: when `true`, allows using S3 buckets from different regions. Default: `false`
422422
* [`IMGPROXY_S3_USE_DECRYPTION_CLIENT`]: when `true`, enables client-side decryption. Default: `false`
423+
* [`IMGPROXY_S3_ASSUME_ROLE_ARN`]: a custom role to assume
424+
* [`IMGPROXY_S3_ASSUME_ROLE_EXTERNAL_ID`]: the external ID required to assume a custom role
423425

424426
Check out the [Serving files from S3](../image_sources/amazon_s3.mdx) guide to learn more.
425427

docs/image_sources/amazon_s3.mdx

+3-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ imgproxy can process images from S3 buckets. To use this feature, do the followi
1313
5. _(optional)_ Set the `IMGPROXY_S3_MULTI_REGION` environment variable to be `true`.
1414
6. _(optional)_ Set the `IMGPROXY_S3_USE_DECRYPTION_CLIENT` environment variable to `true` if your objects are client-side encrypted.
1515
7. _(optional)_ Specify the AWS IAM Role to Assume with `IMGPROXY_S3_ASSUME_ROLE_ARN`.
16-
8. Use `s3://%bucket_name/%file_key` as the source image URL.
16+
8. _(optional)_ Specify the External ID that needs to be passed in along with the AWS IAM Role to Assume with `IMGPROXY_S3_ASSUME_ROLE_EXTERNAL_ID`. This will have no effect if the assume role ARN is not specified.
17+
9. Use `s3://%bucket_name/%file_key` as the source image URL.
1718

1819
If you need to specify the version of the source object, you can use the query string of the source URL:
1920

@@ -56,7 +57,7 @@ aws_secret_access_key = %secret_access_key
5657

5758
#### Cross-Account Access
5859

59-
S3 access credentials may be acquired by assuming a role using STS. To do so specify the IAM Role arn with the `IMGPROXY_S3_ASSUME_ROLE_ARN` environment variable. This approach still requires you to provide initial AWS credentials by using one of the ways described above. The provided credentials role should allow assuming the role with provided ARN.
60+
S3 access credentials may be acquired by assuming a role using STS. To do so specify the IAM Role arn with the `IMGPROXY_S3_ASSUME_ROLE_ARN` environment variable. Additionally, if you require an external ID to be passed when assuming a role, specify the `IMGPROXY_S3_ASSUME_ROLE_EXTERNAL_ID` environment variable. This approach still requires you to provide initial AWS credentials by using one of the ways described above. The provided credentials role should allow assuming the role with provided ARN.
6061

6162
## Multi-Region mode
6263

0 commit comments

Comments
 (0)