diff options
| author | Christian Bläul | 2019-08-17 12:19:34 +0200 |
|---|---|---|
| committer | Christian Bläul | 2019-08-17 12:19:34 +0200 |
| commit | d21ede4df8b1066ff5a2a11d4753f55d1c40823d (patch) | |
| tree | 06757a793e9e8191f0873a60e2e1424a769e3056 /docs | |
| parent | 3684c65f104e8669eda7c2f76fe772fc0fd74010 (diff) | |
Documentation: improved 'Users and Privileges' section
Signed-off-by: Christian Bläul <christian@blaeul.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration-config-file.md | 2 | ||||
| -rw-r--r-- | docs/configuration-env-vars.md | 8 |
2 files changed, 5 insertions, 5 deletions
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md index 3dfb2335..39c5c204 100644 --- a/docs/configuration-config-file.md +++ b/docs/configuration-config-file.md @@ -91,7 +91,7 @@ these are rarely used for various reasons. | `allowAnonymous` | `true` or `false` | Set to allow anonymous usage (default is `true`). | | `allowAnonymousEdits` | `true` or `false` | If `allowAnonymous` is `true`: allow users to select `freely` permission, allowing guests to edit existing notes (default is `false`). | | `allowFreeURL` | `true` or `false` | Set to allow new note creation by accessing a nonexistent note URL. This is the behavior familiar from [Etherpad](https://github.com/ether/etherpad-lite). | -| `defaultPermission` | `freely`, `editable`, `limited`, `locked`, `protected` or `private` | Set notes default permission (only applied on signed users). | +| `defaultPermission` | `freely`, `editable`, `limited`, `locked`, `protected` or `private` | Set notes default permission (only applied on signed-in users). | | `sessionName` | `connect.sid` | Cookie session name. | | `sessionLife` | `14 * 24 * 60 * 60 * 1000` (14 days) | Cookie session life time in milliseconds. | | `sessionSecret` | `secret` | Cookie session secret. If none is set, one will randomly generated on each startup, meaning all your users will be logged out. | diff --git a/docs/configuration-env-vars.md b/docs/configuration-env-vars.md index 2c457755..1f44083e 100644 --- a/docs/configuration-env-vars.md +++ b/docs/configuration-env-vars.md @@ -76,10 +76,10 @@ defaultNotePath can't be set from env-vars | variable | example value | description | | -------- | ------------- | ----------- | -| `CMD_ALLOW_ANONYMOUS` | `true` or `false` | set to allow anonymous usage (default is `true`) | -| `CMD_ALLOW_ANONYMOUS_EDITS` | `true` or `false` | if `allowAnonymous` is `true`, allow users to select `freely` permission, allowing guests to edit existing notes (default is `false`) | -| `CMD_ALLOW_FREEURL` | `true` or `false` | set to allow new note creation by accessing a nonexistent note URL | -| `CMD_DEFAULT_PERMISSION` | `freely`, `editable`, `limited`, `locked` or `private` | set notes default permission (only applied on signed users) | +| `CMD_ALLOW_ANONYMOUS` | `true` or `false` | Set to allow anonymous usage (default is `true`). | +| `CMD_ALLOW_ANONYMOUS_EDITS` | `true` or `false` | If `allowAnonymous` is `true`: allow users to select `freely` permission, allowing guests to edit existing notes (default is `false`). | +| `CMD_ALLOW_FREEURL` | `true` or `false` | Set to allow new note creation by accessing a nonexistent note URL. This is the behavior familiar from [Etherpad](https://github.com/ether/etherpad-lite). | +| `CMD_DEFAULT_PERMISSION` | `freely`, `editable`, `limited`, `locked`, `protected` or `private` | Set notes default permission (only applied on signed-in users). | | `CMD_SESSION_LIFE` | `1209600000` (14 days) | Cookie session life time in milliseconds. | | `CMD_SESSION_SECRET` | no example | Secret used to sign the session cookie. If none is set, one will randomly generated on each startup, meaning all your users will be logged out. | |