From a46b244babbd3da0c0e92f5950039ce59a93f15c Mon Sep 17 00:00:00 2001 From: Umputun Date: Mon, 4 Jun 2018 15:39:45 -0500 Subject: [PATCH] add max cache size info to readme --- README.md | 53 +++++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 012bcb75..a4cda8e2 100644 --- a/README.md +++ b/README.md @@ -30,32 +30,33 @@ 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 | `./var` | no | path to data directory | -| --site | SITE | `remark` | yes | site name(s) | -| --admin | ADMIN | | yes | admin names (list of user ids) | -| --backup | BACKUP_PATH | `./var/backup` | 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, `0` - unlimited | -| --avatars | AVATAR_STORE | `./var/avatars` | no | avatars location | -| --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 | -| --yandex-cid | REMARK_YANDEX_CID | | no | Yandex OAuth client ID | -| --yandex-csec | REMARK_YANDEX_CSEC | | no | Yandex OAuth client secret | -| --low-score | LOW_SCORE | `-5` | no | Low score threshold | -| --critical-score | CRITICAL_SCORE | `-10` | no | Critical score threshold | -| --img-proxy | IMG_PROXY | `false` | no | Enable http->https proxy for images | -| --dbg | DEBUG | `false` | no | debug mode | -| --dev-passwd | 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 | `./var` | no | path to data directory | +| --site | SITE | `remark` | yes | site name(s) | +| --admin | ADMIN | | yes | admin names (list of user ids) | +| --backup | BACKUP_PATH | `./var/backup` | 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, `0` - unlimited | +| --max-cache-size | MAX_CACHE_SIZE | `50000000` | no | max size of all cached values, `0` - unlimited | +| --avatars | AVATAR_STORE | `./var/avatars` | no | avatars location | +| --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 | +| --yandex-cid | REMARK_YANDEX_CID | | no | Yandex OAuth client ID | +| --yandex-csec | REMARK_YANDEX_CSEC | | no | Yandex OAuth client secret | +| --low-score | LOW_SCORE | `-5` | no | Low score threshold | +| --critical-score | CRITICAL_SCORE | `-10` | no | Critical score threshold | +| --img-proxy | IMG_PROXY | `false` | no | Enable http->https proxy for images | +| --dbg | DEBUG | `false` | no | debug mode | +| --dev-passwd | DEV_PASSWD | | no | password for `dev` user | **user has to provide secret key, can be any long and hard-to-guess string.**