Skip to content

Commit

Permalink
📝 README: Improve AWS user setup
Browse files Browse the repository at this point in the history
  • Loading branch information
ThePooN committed Feb 7, 2021
1 parent 11bd261 commit 9709154
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,22 @@ A feature-rich Amazon S3 NGINX-based proxy, running in Docker and Kubernetes.

# Usage

Create AWS S3 access key and secret keys, allowed to download from your buckets. Bucket listing will also be served, so make sure to disable that permission if necessary.
Recommended setup is to create an AWS IAM user for each `s3-nginx-proxy` deployment. You should then attach a policy to exclusively grant it the `GetObject` permission on the required buckets, such as:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::thepoon.ppy.sh/*"
}
]
}
```

Granting too much permissions may lead to security risks (such as listing the entire bucket content). Be careful!

## Docker

Expand Down

0 comments on commit 9709154

Please sign in to comment.