Skip to content

Commit 74a7216

Browse files
authored
Merge pull request #553 from weisslj/fix-s3-bucket-documentation
Correct documentation of S3 bucket
2 parents d96385e + 89a2389 commit 74a7216

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,8 @@ Application settings `config.json`
195195
| email | `true` or `false` | set to allow email signin |
196196
| allowemailregister | `true` or `false` | set to allow email register (only applied when email is set, default is `true`) |
197197
| imageUploadType | `imgur`(default), `s3` or `filesystem` | Where to upload image
198-
| s3 | `{ "accessKeyId": "YOUR_S3_ACCESS_KEY_ID", "secretAccessKey": "YOUR_S3_ACCESS_KEY", "region": "YOUR_S3_REGION", "bucket": "YOUR_S3_BUCKET_NAME" }` | When `imageUploadType` be setted to `s3`, you would also need to setup this key, check our [S3 Image Upload Guide](docs/guides/s3-image-upload.md) |
198+
| s3 | `{ "accessKeyId": "YOUR_S3_ACCESS_KEY_ID", "secretAccessKey": "YOUR_S3_ACCESS_KEY", "region": "YOUR_S3_REGION" }` | When `imageUploadType` be setted to `s3`, you would also need to setup this key, check our [S3 Image Upload Guide](docs/guides/s3-image-upload.md) |
199+
| s3bucket | `YOUR_S3_BUCKET_NAME` | bucket name when `imageUploadType` is set to `s3` |
199200

200201
Third-party integration api key settings
201202
---

docs/guides/s3-image-upload.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@
6767
"s3": {
6868
"accessKeyId": "YOUR_S3_ACCESS_KEY_ID",
6969
"secretAccessKey": "YOUR_S3_ACCESS_KEY",
70-
"region": "YOUR_S3_REGION", // example: ap-northeast-1
71-
"bucket": "YOUR_S3_BUCKET_NAME"
72-
}
70+
"region": "YOUR_S3_REGION" // example: ap-northeast-1
71+
},
72+
"s3bucket": "YOUR_S3_BUCKET_NAME"
7373
}
7474
}
7575
```

0 commit comments

Comments
 (0)