summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWu Cheng-Han2017-01-13 00:51:40 +0800
committerWu Cheng-Han2017-01-13 00:51:40 +0800
commit3cf40a8dec96af3710a5945dde693fdc949f31af (patch)
tree9f2b9c11a28fde7b529ef4e8e3b250f04b6af70b
parent86f0b10775ec85fa3ee0d5c64a814ab34e17f3d6 (diff)
Update README.md to describe allowemailregister config more clear
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7d3d4573..2e7b919b 100644
--- a/README.md
+++ b/README.md
@@ -151,7 +151,7 @@ Environment variables (will overwrite other server configs)
| HMD_LDAP_PROVIDERNAME | My institution | Optional name to be displayed at login form indicating the LDAP provider |
| HMD_IMGUR_CLIENTID | no example | Imgur API client id |
| HMD_EMAIL | `true` or `false` | set to allow email signin |
-| HMD_ALLOW_EMAIL_REGISTER | `true` or `false` | set to allow email register |
+| HMD_ALLOW_EMAIL_REGISTER | `true` or `false` | set to allow email register (only applied when email is set, default is `true`) |
| HMD_IMAGE_UPLOAD_TYPE | `imgur`, `s3` or `filesystem` | Where to upload image. For S3, see our [S3 Image Upload Guide](docs/guides/s3-image-upload.md) |
| HMD_S3_ACCESS_KEY_ID | no example | AWS access key id |
| HMD_S3_SECRET_ACCESS_KEY | no example | AWS secret key |
@@ -196,7 +196,7 @@ Server settings `config.json`
| heartbeattimeout | `10000` | socket.io heartbeat timeout |
| documentmaxlength | `100000` | note max length |
| email | `true` or `false` | set to allow email signin |
-| allowemailregister | `true` or `false` | set to allow email register |
+| 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) |