clarify --secret usage based on #861

umputun · May 5, 2021 · 0314021 · 0314021
1 parent d361564
commit 0314021
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -106,7 +106,7 @@ _this is the recommended way to run remark42_
 | Command line            | Environment             | Default                  | Description                                     |
 | ----------------------- | ----------------------- | ------------------------ | ----------------------------------------------- |
 | url                     | REMARK_URL              |                          | url to remark42 server, _required_              |
-| secret                  | SECRET                  |                          | secret key, _required_                          |
+| secret                  | SECRET                  |                          | shared secret key used to sign JWT, should be a random, long, hard-to-guess string, _required_ |
 | site                    | SITE                    | `remark`                 | site name(s), _multi_                           |
 | store.type              | STORE_TYPE              | `bolt`                   | type of storage, `bolt` or `rpc`                |
 | store.bolt.path         | STORE_BOLT_PATH         | `./var`                  | path to data directory                          |

diff --git a/backend/app/main.go b/backend/app/main.go
@@ -24,7 +24,7 @@ type Opts struct {
 	RemapCmd   cmd.RemapCommand   `command:"remap"`
 
 	RemarkURL    string `long:"url" env:"REMARK_URL" required:"true" description:"url to remark"`
-	SharedSecret string `long:"secret" env:"SECRET" required:"true" description:"shared secret key"`
+	SharedSecret string `long:"secret" env:"SECRET" required:"true" description:"shared secret key used to sign JWT, should be a random, long, hard-to-guess string"`
 
 	Dbg bool `long:"dbg" env:"DEBUG" description:"debug mode"`
 }