diff options
| author | Christoph (Sheogorath) Kern | 2018-06-18 03:42:42 +0200 |
|---|---|---|
| committer | GitHub | 2018-06-18 03:42:42 +0200 |
| commit | 82c7f9d07cfecfc110af8c8fc0e47edf070596b2 (patch) | |
| tree | c79676f2e7d78120a8d73bf30c94f371d4e2b690 /README.md | |
| parent | 818d82559e93daf86b619fb86ee1eabf0916506f (diff) | |
| parent | 10dbd537b4781e53d67de882faa84217ce4005fb (diff) | |
Merge pull request #844 from hackmdio/docs/fix-default
Fix wrong docs about default image upload location
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -209,7 +209,7 @@ There are some config settings you need to change in the files below. | `HMD_EMAIL` | `true` or `false` | set to allow email signin | | `HMD_ALLOW_PDF_EXPORT` | `true` or `false` | Enable or disable PDF exports | | `HMD_ALLOW_EMAIL_REGISTER` | `true` or `false` | set to allow email register (only applied when email is set, default is `true`. Note `bin/manage_users` might help you if registration is `false`.) | -| `HMD_IMAGE_UPLOAD_TYPE` | `imgur`, `s3`, `minio` or `filesystem` | Where to upload image. For S3, see our Image Upload Guides for [S3](docs/guides/s3-image-upload.md) or [Minio](docs/guides/minio-image-upload.md) | +| `HMD_IMAGE_UPLOAD_TYPE` | `imgur`, `s3`, `minio` or `filesystem` | Where to upload images. For S3, see our Image Upload Guides for [S3](docs/guides/s3-image-upload.md) or [Minio](docs/guides/minio-image-upload.md) | | `HMD_S3_ACCESS_KEY_ID` | no example | AWS access key id | | `HMD_S3_SECRET_ACCESS_KEY` | no example | AWS secret key | | `HMD_S3_REGION` | `ap-northeast-1` | AWS S3 region | @@ -270,7 +270,7 @@ There are some config settings you need to change in the files below. | `documentMaxLength` | `100000` | note max length | | `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`. Note `bin/manage_users` might help you if registration is `false`.) | -| `imageUploadType` | `imgur`(default), `s3`, `minio`, `azure` or `filesystem` | Where to upload image +| `imageUploadType` | `imgur`, `s3`, `minio`, `azure` or `filesystem`(default) | Where to upload images. For S3, see our Image Upload Guides for [S3](docs/guides/s3-image-upload.md) or [Minio](docs/guides/minio-image-upload.md)| | `minio` | `{ "accessKey": "YOUR_MINIO_ACCESS_KEY", "secretKey": "YOUR_MINIO_SECRET_KEY", "endpoint": "YOUR_MINIO_HOST", port: 9000, secure: true }` | When `imageUploadType` is set to `minio`, you need to set this key. Also checkout our [Minio Image Upload Guide](docs/guides/minio-image-upload.md) | | `s3` | `{ "accessKeyId": "YOUR_S3_ACCESS_KEY_ID", "secretAccessKey": "YOUR_S3_ACCESS_KEY", "region": "YOUR_S3_REGION" }` | When `imageuploadtype` be set 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` or `minio` | |