Explorar el Código

Update docs/serving_files_from_s3.md

Travis-Turner hace 4 años
padre
commit
66dbf644ce
Se han modificado 1 ficheros con 12 adiciones y 12 borrados
  1. 12 12
      docs/serving_files_from_s3.md

+ 12 - 12
docs/serving_files_from_s3.md

@@ -2,25 +2,25 @@
 
 
 imgproxy can process images from S3 buckets. To use this feature, do the following:
 imgproxy can process images from S3 buckets. To use this feature, do the following:
 
 
-1. Set `IMGPROXY_USE_S3` environment variable as `true`;
-2. [Setup credentials](#setup-credentials) to grant access to your bucket;
-3. _(optional)_ Specify AWS region with `IMGPROXY_S3_REGION` or `AWS_REGION`. Default: `us-west-1`;
-4. _(optional)_ Specify S3 endpoint with `IMGPROXY_S3_ENDPOINT`;
+1. Set the `IMGPROXY_USE_S3` environment variable to be `true`.
+2. [Set up the necessary credentials](#setup-credentials) to grant access to your bucket.
+3. _(optional)_ Specify the AWS region with `IMGPROXY_S3_REGION` or `AWS_REGION`. Default: `us-west-1`
+4. _(optional)_ Specify the S3 endpoint with `IMGPROXY_S3_ENDPOINT`.
 5. Use `s3://%bucket_name/%file_key` as the source image URL.
 5. Use `s3://%bucket_name/%file_key` as the source image URL.
 
 
-If you need to specify version of the source object, you can use query string of the source URL:
+If you need to specify the version of the source object, you can use the query string of the source URL:
 
 
 ```
 ```
 s3://%bucket_name/%file_key?%version_id
 s3://%bucket_name/%file_key?%version_id
 ```
 ```
 
 
-### Setup credentials
+### Set up credentials
 
 
 There are three ways to specify your AWS credentials. The credentials need to have read rights for all of the buckets given in the source URLs.
 There are three ways to specify your AWS credentials. The credentials need to have read rights for all of the buckets given in the source URLs.
 
 
 #### Environment variables
 #### Environment variables
 
 
-You can specify AWS Acces Key ID and Secret Access Key by setting the standard `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
+You can specify an AWS Access Key ID and a Secret Access Key by setting the standard `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
 
 
 ``` bash
 ``` bash
 AWS_ACCESS_KEY_ID=my_access_key AWS_SECRET_ACCESS_KEY=my_secret_key imgproxy
 AWS_ACCESS_KEY_ID=my_access_key AWS_SECRET_ACCESS_KEY=my_secret_key imgproxy
@@ -29,11 +29,11 @@ AWS_ACCESS_KEY_ID=my_access_key AWS_SECRET_ACCESS_KEY=my_secret_key imgproxy
 docker run -e AWS_ACCESS_KEY_ID=my_access_key -e AWS_SECRET_ACCESS_KEY=my_secret_key -it darthsim/imgproxy
 docker run -e AWS_ACCESS_KEY_ID=my_access_key -e AWS_SECRET_ACCESS_KEY=my_secret_key -it darthsim/imgproxy
 ```
 ```
 
 
-It is the recommended way to use with dockerized imgproxy.
+This is the recommended method when using dockerized imgproxy.
 
 
 #### Shared credentials file
 #### Shared credentials file
 
 
-Otherwise, you can create the `.aws/credentials` file in your home directory with the following content:
+Alternatively, you can create the `.aws/credentials` file in your home directory with the following content:
 
 
 ```ini
 ```ini
 [default]
 [default]
@@ -43,7 +43,7 @@ aws_secret_access_key = %secret_access_key
 
 
 #### IAM Roles for Amazon EC2 Instances
 #### IAM Roles for Amazon EC2 Instances
 
 
-If you are running imgproxy on an Amazon EC2 instance, you can use the instance's [IAM role](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) to get security credentials to make calls to AWS S3.
+If you're running imgproxy on an Amazon EC2 instance, you can use the instance's [IAM role](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) to get the security credentials to make calls to AWS S3.
 
 
 You can learn about credentials in the [Configuring the AWS SDK for Go](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html) guide.
 You can learn about credentials in the [Configuring the AWS SDK for Go](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html) guide.
 
 
@@ -53,5 +53,5 @@ You can learn about credentials in the [Configuring the AWS SDK for Go](https://
 
 
 To use Minio as source images provider, do the following:
 To use Minio as source images provider, do the following:
 
 
-* Setup Amazon S3 support as usual using environment variables or shared config file;
-* Specify endpoint with `IMGPROXY_S3_ENDPOINT`. Use `http://...` endpoint to disable SSL.
+* Set up Amazon S3 support as usual using environment variables or a shared config file.
+* Specify an endpoint with `IMGPROXY_S3_ENDPOINT`. Use the `http://...` endpoint to disable SSL.