Skip to content

Commit ae8b895

Browse files
committed
[DOC] Updated README.md to include S3 perimssions
[DOC] Updated README.md to include minimum permissions required on the S3 bucket for the plugin to work.
1 parent 4c41855 commit ae8b895

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,33 @@ The following properties are expected to be present on the deployment `context`
158158
- `gzippedFiles` (provided by [ember-cli-deploy-gzip][3])
159159
- `manifestPath` (provided by [ember-cli-deploy-manifest][4])
160160

161+
## Minimum S3 Permissions
162+
163+
Ensure you have the minimum required permissions configured for the user (accessKeyId). A bare minimum policy should have the following permissions:
164+
165+
```
166+
{
167+
"Statement": [
168+
{
169+
"Sid": "Stmt1EmberCLIS3DeployPolicy",
170+
"Effect": "Allow",
171+
"Action": [
172+
"s3:GetObject",
173+
"s3:PutObject",
174+
"s3:PutObjectACL"
175+
],
176+
"Resource": [
177+
"arn:aws:s3:::<your-s3-bucket-name>/*"
178+
]
179+
}
180+
]
181+
}
182+
183+
```
184+
Replace <your-s3-bucket-name> with the name of the actual bucket you are deploying to. Also, remember that "PutObject" permission will effectively overwrite any existing files with the same name unless you use a fingerprinting or a manifest plugin.
185+
186+
187+
161188
## Running Tests
162189

163190
- `npm test`

0 commit comments

Comments
 (0)