diff --git a/README.md b/README.md index 912f505b..61ba1fc0 100644 --- a/README.md +++ b/README.md @@ -29,25 +29,28 @@ Remark42 is a self-hosted, lightweight, and simple (yet functional) comment engi #### Parameters -| Command line | Environment | Default | Multi | Description | -| --------------- | -------------------- | ---------------------- | ---------------- | ------------------------------- | -| --url | REMARK_URL | `https://remark42.com` | no | url to remark server | -| --bolt | BOLTDB_PATH | `/tmp` | no | path to data directory | -| --site | SITE | `remark` | yes | site name(s) | -| --admin | ADMIN | | yes | admin names (list of user ids) | -| --backup | BACKUP_PATH | `/tmp` | no | backups location | -| --max-back | MAX_BACKUP_FILES | `10` | no | max backup files to keep | -| --session | SESSION_STORE | `/tmp` | no | path to session store directory | -| --secret | SECRET | | no | secret key, required | -| --max-comment | MAX_COMMENT_SIZE | 2048 | no | comment's size limit | -| --google-cid | REMARK_GOOGLE_CID | | no | Google OAuth client ID | -| --google-csec | REMARK_GOOGLE_CSEC | | no | Google OAuth client secret | -| --facebook-cid | REMARK_FACEBOOK_CID | | no | Facebook OAuth client ID | -| --facebook-csec | REMARK_FACEBOOK_CSEC | | no | Facebook OAuth client secret | -| --github-cid | REMARK_GITHUB_CID | | no | Github OAuth client ID | -| --github-csec | REMARK_GITHUB_CSEC | | no | Github OAuth client secret | -| --dbg | DEBUG | `false` | no | debug mode | -| --dev-password | DEV_PASSWD | | no | password for `dev` user | +| Command line | Environment | Default | Multi | Description | +| ----------------- | -------------------- | ---------------------- | ---------------- | --------------------------------------- | +| --url | REMARK_URL | `https://remark42.com` | no | url to remark server | +| --bolt | BOLTDB_PATH | `/tmp` | no | path to data directory | +| --site | SITE | `remark` | yes | site name(s) | +| --admin | ADMIN | | yes | admin names (list of user ids) | +| --backup | BACKUP_PATH | `/tmp` | no | backups location | +| --max-back | MAX_BACKUP_FILES | `10` | no | max backup files to keep | +| --max-cache-items | MAX_CACHE_ITEMS | `1000` | no | max number of cached items, 0-unlimited | +| --max-cache-value | MAX_CACHE_VALUE | `65536` | no | max size of cached value, o-unlimited | +| --session | SESSION_STORE | `/tmp` | no | path to session store directory | +| --secret | SECRET | | no | secret key, required | +| --max-comment | MAX_COMMENT_SIZE | `2048` | no | comment's size limit | +| --google-cid | REMARK_GOOGLE_CID | | no | Google OAuth client ID | +| --google-csec | REMARK_GOOGLE_CSEC | | no | Google OAuth client secret | +| --facebook-cid | REMARK_FACEBOOK_CID | | no | Facebook OAuth client ID | +| --facebook-csec | REMARK_FACEBOOK_CSEC | | no | Facebook OAuth client secret | +| --github-cid | REMARK_GITHUB_CID | | no | Github OAuth client ID | +| --github-csec | REMARK_GITHUB_CSEC | | no | Github OAuth client secret | +| --dbg | DEBUG | `false` | no | debug mode | +| --dev-password | DEV_PASSWD | | no | password for `dev` user | + **User has to provide secret key, can be any long and hard-to-guess string.**