From 3b195070a4582c53578a2f90704ce037fc9ee640 Mon Sep 17 00:00:00 2001 From: Umputun Date: Sun, 10 Jun 2018 16:33:53 -0500 Subject: [PATCH] add cli details --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f3ac07cd..fe239181 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Remark42 is a self-hosted, lightweight, and simple (yet functional) comment engi * Import from disqus * Markdown support * Moderator can remove comments and block users -* Voting and pinning system +* Voting, pinning and verification system * Sortable comments * Extractor for recent comments, cross-post * RSS for all comments and each post @@ -17,6 +17,7 @@ Remark42 is a self-hosted, lightweight, and simple (yet functional) comment engi * Clean, lightweight and fully customizable UI * Multi-site mode from a single instance * Integration with automatic ssl via [nginx-le](https://github.com/umputun/nginx-le) +* [Privacy focused](#privacy) ## Install @@ -59,8 +60,9 @@ Remark42 is a self-hosted, lightweight, and simple (yet functional) comment engi | dbg | DEBUG | `false` | debug mode | | dev-passwd | DEV_PASSWD | | password for `dev` user | -1. _multi_ parameters separated by `,` in the environment or repeated with command line key, like `--site=s1 --site=s2 ...` -2. _required_ parameters have to be presented in the environment or provided in command line_ +* command line parameters are long form `--=value`, i.e. `--site=https://demo.remark42.com` +* _multi_ parameters separated by `,` in the environment or repeated with command line key, like `--site=s1 --site=s2 ...` +* _required_ parameters have to be presented in the environment or provided in command line_ ##### Required parameters @@ -84,8 +86,8 @@ services: - REMARK_URL=https://demo.remark42.com # url pointing to your remark42 server - USER=1001 # UID on the host machine - SECRET=abcd-123456-xyz-$%^& # secret key - - AUTH_GITHUB_CID=12345667890 # oauth2 client ID - - AUTH_GITHUB_CSEC=abcdefg12345678 # oauth2 client secret + - AUTH_GITHUB_CID=12345667890 # oauth2 client ID + - AUTH_GITHUB_CSEC=abcdefg12345678 # oauth2 client secret volumes: - ./var:/srv/var # persistent volume to store all remark42 data ```