summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSheogorath2017-10-07 01:20:43 +0200
committerGitHub2017-10-07 01:20:43 +0200
commit74a7216a305e2f17f838f4dac416e15699a6f2e9 (patch)
treeaeb911c09ee0cfc1ae79b1410790d4273790c349
parentd96385eafdc8e9c408088a3f95a60c9a0193ef67 (diff)
parent89a23895862736a7c54b446849531e25d5029432 (diff)
Merge pull request #553 from weisslj/fix-s3-bucket-documentation
Correct documentation of S3 bucket
Diffstat (limited to '')
-rw-r--r--README.md3
-rw-r--r--docs/guides/s3-image-upload.md6
2 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index 2c764d3f..f3de14a6 100644
--- a/README.md
+++ b/README.md
@@ -195,7 +195,8 @@ Application settings `config.json`
| email | `true` or `false` | set to allow email signin |
| allowemailregister | `true` or `false` | set to allow email register (only applied when email is set, default is `true`) |
| imageUploadType | `imgur`(default), `s3` or `filesystem` | Where to upload image
-| 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) |
+| 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) |
+| s3bucket | `YOUR_S3_BUCKET_NAME` | bucket name when `imageUploadType` is set to `s3` |
Third-party integration api key settings
---
diff --git a/docs/guides/s3-image-upload.md b/docs/guides/s3-image-upload.md
index 3d6259b9..dbbef474 100644
--- a/docs/guides/s3-image-upload.md
+++ b/docs/guides/s3-image-upload.md
@@ -67,9 +67,9 @@
"s3": {
"accessKeyId": "YOUR_S3_ACCESS_KEY_ID",
"secretAccessKey": "YOUR_S3_ACCESS_KEY",
- "region": "YOUR_S3_REGION", // example: ap-northeast-1
- "bucket": "YOUR_S3_BUCKET_NAME"
- }
+ "region": "YOUR_S3_REGION" // example: ap-northeast-1
+ },
+ "s3bucket": "YOUR_S3_BUCKET_NAME"
}
}
```