From c065d45da89d212d4a41761f5142c231634b41d8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <blaeul@quodata.de>
Date: Fri, 16 Aug 2019 23:13:53 +0200
Subject: [PATCH 01/12] Documentation of config options: Improve db
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
docs/configuration-config-file.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md
index b233cebea..871e4b313 100644
--- a/docs/configuration-config-file.md
+++ b/docs/configuration-config-file.md
@@ -26,7 +26,7 @@ to `config.json` before filling in your own details.
| --------- | ------ | ----------- |
| `allowPDFExport` | `true` | Whether or not PDF export is offered. |
| `db` | `{ "dialect": "sqlite", "storage": "./db.codimd.sqlite" }` | set the db configs, [see more here](http://sequelize.readthedocs.org/en/latest/api/sequelize/) |
-| `dbURL` | `mysql://localhost:3306/database` | set the db URL; if set, then db config (below) won't be applied |
+| `dbURL` | `mysql://localhost:3306/database` | set the db URL; if set, then `db` config will be overridden. |
| `forbiddenNoteIDs` | `['robots.txt']` | disallow creation of notes, even if `allowFreeUrl` is `true` |
| `loglevel` | `info` | Defines what kind of logs are provided to stdout. |
| `imageUploadType` | `imgur`, `s3`, `minio`, `azure`, `lutim` or `filesystem`(default) | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [Minio](guides/minio-image-upload.md)|
From f49bbf4c45606655d86655bd60c02aafbfbe1fb0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <blaeul@quodata.de>
Date: Fri, 16 Aug 2019 23:14:35 +0200
Subject: [PATCH 02/12] Documentation of config options: Improve loglevel
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
docs/configuration-config-file.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md
index 871e4b313..e840ecc79 100644
--- a/docs/configuration-config-file.md
+++ b/docs/configuration-config-file.md
@@ -28,7 +28,7 @@ to `config.json` before filling in your own details.
| `db` | `{ "dialect": "sqlite", "storage": "./db.codimd.sqlite" }` | set the db configs, [see more here](http://sequelize.readthedocs.org/en/latest/api/sequelize/) |
| `dbURL` | `mysql://localhost:3306/database` | set the db URL; if set, then `db` config will be overridden. |
| `forbiddenNoteIDs` | `['robots.txt']` | disallow creation of notes, even if `allowFreeUrl` is `true` |
-| `loglevel` | `info` | Defines what kind of logs are provided to stdout. |
+| `loglevel` | `info` | Defines what kind of logs are provided to stdout. Available options: `debug`, `verbose`, `info`, `warn`, `error` |
| `imageUploadType` | `imgur`, `s3`, `minio`, `azure`, `lutim` or `filesystem`(default) | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [Minio](guides/minio-image-upload.md)|
| `sourceURL` | `https://github.com/codimd/server/tree/<current commit>` | Provides the link to the source code of CodiMD on the entry page (Please, make sure you change this when you run a modified version) |
| `staticCacheTime` | `1 * 24 * 60 * 60 * 1000` | static file cache time |
From 305525aa0c0f31d2638f513b4e8dfdebb7de23db Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <blaeul@quodata.de>
Date: Fri, 16 Aug 2019 23:19:27 +0200
Subject: [PATCH 03/12] Config documentation: Improved spelling and
capitalization of services
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
docs/configuration-config-file.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md
index e840ecc79..fd00eb2c2 100644
--- a/docs/configuration-config-file.md
+++ b/docs/configuration-config-file.md
@@ -29,10 +29,10 @@ to `config.json` before filling in your own details.
| `dbURL` | `mysql://localhost:3306/database` | set the db URL; if set, then `db` config will be overridden. |
| `forbiddenNoteIDs` | `['robots.txt']` | disallow creation of notes, even if `allowFreeUrl` is `true` |
| `loglevel` | `info` | Defines what kind of logs are provided to stdout. Available options: `debug`, `verbose`, `info`, `warn`, `error` |
-| `imageUploadType` | `imgur`, `s3`, `minio`, `azure`, `lutim` or `filesystem`(default) | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [Minio](guides/minio-image-upload.md)|
+| `imageUploadType` | `imgur`, `s3`, `minio`, `azure`, `lutim` or `filesystem`(default) | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [MinIO](guides/minio-image-upload.md)|
| `sourceURL` | `https://github.com/codimd/server/tree/<current commit>` | Provides the link to the source code of CodiMD on the entry page (Please, make sure you change this when you run a modified version) |
| `staticCacheTime` | `1 * 24 * 60 * 60 * 1000` | static file cache time |
-| `tooBusyLag` | `70` | CPU time for one eventloop tick until node throttles connections. (milliseconds) |
+| `tooBusyLag` | `70` | CPU time for one event loop tick until node throttles connections. (milliseconds) |
| `heartbeatInterval` | `5000` | socket.io heartbeat interval |
| `heartbeatTimeout` | `10000` | socket.io heartbeat timeout |
| `documentMaxLength` | `100000` | note max length |
@@ -81,7 +81,7 @@ these are rarely used for various reasons.
| variables | example values | description |
| --------- | ------ | ----------- |
-| `allowGravatar` | `true` or `false` | set to `false` to disable gravatar as profile picture source on your instance |
+| `allowGravatar` | `true` or `false` | set to `false` to disable Gravatar as profile picture source on your instance |
| `useCDN` | `true` or `false` | set to use CDN resources or not (default is `true`) |
## Users and Privileges
@@ -105,7 +105,7 @@ Most of these have never been documented for the config.json, feel free to expan
| variables | example values | description |
| --------- | ------ | ----------- |
-| `email` | `true` or `false` | set to allow email signin |
+| `email` | `true` or `false` | set to allow email sign-in |
| `allowEmailRegister` | `true` or `false` | set to allow email register (only applied when email is set, default is `true`. Note `bin/manage_users` might help you if registration is `false`.) |
### Dropbox Login
@@ -138,8 +138,8 @@ Most of these have never been documented for the config.json, feel free to expan
| `s3bucket` | `YOUR_S3_BUCKET_NAME` | bucket name when `imageUploadType` is set to `s3` or `minio` |
### Azure Blob Storage
-### imgur
-### Minio
+### Imgur
+### MinIO
| variables | example values | description |
| --------- | ------ | ----------- |
From 4b392f4b1286107ee7a02a45dbf2abf29bde19f5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <blaeul@quodata.de>
Date: Fri, 16 Aug 2019 23:46:17 +0200
Subject: [PATCH 04/12] Improved docs for YAML metadata
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
public/docs/yaml-metadata.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md
index 839616a8f..8e59c8f2f 100644
--- a/public/docs/yaml-metadata.md
+++ b/public/docs/yaml-metadata.md
@@ -31,7 +31,7 @@ title: meta title
description
---
-This option will set the note description.
+This option will set the note description as a `<meta name="description">` tag. This only affects the [Publish](../features#Share-Notes) function.
> default: not set
@@ -68,7 +68,8 @@ robots: noindex, nofollow
lang
---
-This option will set the language of the note, that might alter some typography of it.
+This option will set the language of the note.
+Setting the language helps the browser to apply rules such as typography correctly.
You can find your the language code in ISO 639-1 standard:
https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
From 374ee5879010a1e52633032c3a4cb864af9c4a01 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <christian@blaeul.de>
Date: Sat, 17 Aug 2019 10:45:01 +0200
Subject: [PATCH 05/12] Documentation: converted descriptions to sentences to
allow more details
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
No content was added; this is just a formatting commit.
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
docs/configuration-config-file.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md
index fd00eb2c2..6ad692b14 100644
--- a/docs/configuration-config-file.md
+++ b/docs/configuration-config-file.md
@@ -88,13 +88,13 @@ these are rarely used for various reasons.
| variables | example values | description |
| --------- | ------ | ----------- |
-| `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 |
-| `defaultPermission` | `freely`, `editable`, `limited`, `locked`, `protected` or `private` | set notes default permission (only applied on signed users) |
-| `sessionName` | `connect.sid` | cookie session name |
-| `sessionLife` | `14 * 24 * 60 * 60 * 1000` | cookie session life |
-| `sessionSecret` | `secret` | cookie session secret | If none is set, one will randomly generated on each startup, meaning all your users will be logged out. |
+| `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. |
+| `defaultPermission` | `freely`, `editable`, `limited`, `locked`, `protected` or `private` | Set notes default permission (only applied on signed users). |
+| `sessionName` | `connect.sid` | Cookie session name. |
+| `sessionLife` | `14 * 24 * 60 * 60 * 1000` | Cookie session life time. |
+| `sessionSecret` | `secret` | Cookie session secret. | If none is set, one will randomly generated on each startup, meaning all your users will be logged out. |
## Login methods
From 60d6a6a15dd029a40d5f267d3143febb7fb4afba Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <christian@blaeul.de>
Date: Sat, 17 Aug 2019 10:53:17 +0200
Subject: [PATCH 06/12] Documentation: Improved descriptions of 'Users and
Privileges' section
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
docs/configuration-config-file.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md
index 6ad692b14..bf8d90ba1 100644
--- a/docs/configuration-config-file.md
+++ b/docs/configuration-config-file.md
@@ -90,11 +90,11 @@ 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. |
+| `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). |
| `sessionName` | `connect.sid` | Cookie session name. |
-| `sessionLife` | `14 * 24 * 60 * 60 * 1000` | Cookie session life time. |
-| `sessionSecret` | `secret` | Cookie session secret. | If none is set, one will randomly generated on each startup, meaning all your users will be logged out. |
+| `sessionLife` | `14 * 24 * 60 * 60 * 1000` | 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. |
## Login methods
From 29e1ff7699b86c327940153ba9dce0fc23794310 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <christian@blaeul.de>
Date: Sat, 17 Aug 2019 11:40:53 +0200
Subject: [PATCH 07/12] Documentation: improved dbURL description
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
docs/configuration-config-file.md | 2 +-
docs/configuration-env-vars.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md
index bf8d90ba1..407eb9e32 100644
--- a/docs/configuration-config-file.md
+++ b/docs/configuration-config-file.md
@@ -26,7 +26,7 @@ to `config.json` before filling in your own details.
| --------- | ------ | ----------- |
| `allowPDFExport` | `true` | Whether or not PDF export is offered. |
| `db` | `{ "dialect": "sqlite", "storage": "./db.codimd.sqlite" }` | set the db configs, [see more here](http://sequelize.readthedocs.org/en/latest/api/sequelize/) |
-| `dbURL` | `mysql://localhost:3306/database` | set the db URL; if set, then `db` config will be overridden. |
+| `dbURL` | `mysql://localhost:3306/database` | Set the db in URL style. If set, then the relevant `db` config entries will be overridden. |
| `forbiddenNoteIDs` | `['robots.txt']` | disallow creation of notes, even if `allowFreeUrl` is `true` |
| `loglevel` | `info` | Defines what kind of logs are provided to stdout. Available options: `debug`, `verbose`, `info`, `warn`, `error` |
| `imageUploadType` | `imgur`, `s3`, `minio`, `azure`, `lutim` or `filesystem`(default) | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [MinIO](guides/minio-image-upload.md)|
diff --git a/docs/configuration-env-vars.md b/docs/configuration-env-vars.md
index bc0eac997..b07547fff 100644
--- a/docs/configuration-env-vars.md
+++ b/docs/configuration-env-vars.md
@@ -30,7 +30,7 @@ defaultNotePath can't be set from env-vars
| -------- | ------------- | ----------- |
| `CMD_ALLOW_PDF_EXPORT` | `true` or `false` | Enable or disable PDF exports |
| `CMD_CONFIG_FILE` | `/path/to/config.json` | optional override for the path to CodiMD's config file |
-| `CMD_DB_URL` | `mysql://localhost:3306/database` | set the database URL |
+| `CMD_DB_URL` | `mysql://localhost:3306/database` | Set the db in URL style. If set, then the relevant `db` config entries will be overridden. |
| `CMD_LOGLEVEL` | `info`, `debug` ... | Defines what kind of logs are provided to stdout. |
| `CMD_FORBIDDEN_NOTE_IDS` | `'robots.txt'` | disallow creation of notes, even if `CMD_ALLOW_FREEURL` is `true` |
| `CMD_IMAGE_UPLOAD_TYPE` | `imgur`, `s3`, `minio`, `lutim` or `filesystem` | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [Minio](guides/minio-image-upload.md), also there's a whole section on their respective env vars below. |
From 32f00e9830ef9497dff9659ca0485953e5466284 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <christian@blaeul.de>
Date: Sat, 17 Aug 2019 11:53:49 +0200
Subject: [PATCH 08/12] Documentation: improved 'Email (local account)'
sections
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
docs/configuration-config-file.md | 4 ++--
docs/configuration-env-vars.md | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md
index 407eb9e32..64d37aff9 100644
--- a/docs/configuration-config-file.md
+++ b/docs/configuration-config-file.md
@@ -105,8 +105,8 @@ Most of these have never been documented for the config.json, feel free to expan
| variables | example values | description |
| --------- | ------ | ----------- |
-| `email` | `true` or `false` | set to allow email sign-in |
-| `allowEmailRegister` | `true` or `false` | set to allow email register (only applied when email is set, default is `true`. Note `bin/manage_users` might help you if registration is `false`.) |
+| `email` | `true` or `false` | Set to allow email sign-in. The default is `true`. |
+| `allowEmailRegister` | `true` or `false` | Set to allow registration of new accounts using an email address. If set to `false`, you can still create accounts using the command line - see `bin/manage_users` for details. This setting has no effect if `email` is `false`. The default for `allowEmailRegister` is `true`. |
### Dropbox Login
### Facebook Login
diff --git a/docs/configuration-env-vars.md b/docs/configuration-env-vars.md
index b07547fff..f4c3bd4e5 100644
--- a/docs/configuration-env-vars.md
+++ b/docs/configuration-env-vars.md
@@ -90,8 +90,8 @@ defaultNotePath can't be set from env-vars
| variable | example value | description |
| -------- | ------------- | ----------- |
-| `CMD_EMAIL` | `true` or `false` | set to allow email signin |
-| `CMD_ALLOW_EMAIL_REGISTER` | `true` or `false` | set to allow email register (only applied when email is set, default is `true`. Note `bin/manage_users` might help you if registration is `false`.) |
+| `CMD_EMAIL` | `true` or `false` | Set to allow email sign-in. The default is `true`. |
+| `CMD_ALLOW_EMAIL_REGISTER` | `true` or `false` | Set to allow registration of new accounts using an email address. If set to `false`, you can still create accounts using the command line - see `bin/manage_users` for details. This setting has no effect if `CMD_EMAIL` is `false`. The default for `CMD_ALLOW_EMAIL_REGISTER` is `true`. |
### Dropbox Login
From ef857a565ca91fbd042ea14ebeddb843952095a4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <christian@blaeul.de>
Date: Sat, 17 Aug 2019 11:56:31 +0200
Subject: [PATCH 09/12] Documentation: improved sessionLife description
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
docs/configuration-config-file.md | 2 +-
docs/configuration-env-vars.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md
index 64d37aff9..3dfb23355 100644
--- a/docs/configuration-config-file.md
+++ b/docs/configuration-config-file.md
@@ -93,7 +93,7 @@ these are rarely used for various reasons.
| `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). |
| `sessionName` | `connect.sid` | Cookie session name. |
-| `sessionLife` | `14 * 24 * 60 * 60 * 1000` | Cookie session life time in milliseconds. |
+| `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 f4c3bd4e5..d3df962a1 100644
--- a/docs/configuration-env-vars.md
+++ b/docs/configuration-env-vars.md
@@ -80,7 +80,7 @@ defaultNotePath can't be set from env-vars
| `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_SESSION_LIFE` | `1209600000` | Session life time. (milliseconds) |
+| `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. |
From 49663390d1e42d28c8079021ba574fb622497270 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <christian@blaeul.de>
Date: Sat, 17 Aug 2019 12:14:24 +0200
Subject: [PATCH 10/12] Not serverurl, but serverURL is used as a default for
issuer
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
config.json.example | 2 +-
docs/configuration-env-vars.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/config.json.example b/config.json.example
index d1c1cc5c9..f627fadb0 100644
--- a/config.json.example
+++ b/config.json.example
@@ -91,7 +91,7 @@
"saml": {
"idpSsoUrl": "change: authentication endpoint of IdP",
"idpCert": "change: certificate file path of IdP in PEM format",
- "issuer": "change or delete: identity of the service provider (default: serverurl)",
+ "issuer": "change or delete: identity of the service provider (default: config.serverURL)",
"identifierFormat": "change or delete: name identifier format (default: 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress')",
"disableRequestedAuthnContext": "change or delete: true to allow any authentication method, false restricts to password authentication method (default: false)",
"groupAttribute": "change or delete: attribute name for group list (ex: memberOf)",
diff --git a/docs/configuration-env-vars.md b/docs/configuration-env-vars.md
index d3df962a1..ef7bf505f 100644
--- a/docs/configuration-env-vars.md
+++ b/docs/configuration-env-vars.md
@@ -183,7 +183,7 @@ defaultNotePath can't be set from env-vars
| -------- | ------------- | ----------- |
| `CMD_SAML_IDPSSOURL` | `https://idp.example.com/sso` | authentication endpoint of IdP. for details, see [guide](guides/auth/saml-onelogin.md). |
| `CMD_SAML_IDPCERT` | `/path/to/cert.pem` | certificate file path of IdP in PEM format |
-| `CMD_SAML_ISSUER` | no example | identity of the service provider (optional, default: serverurl)" |
+| `CMD_SAML_ISSUER` | no example | Issuer to supply to identity provider (optional, default: `serverURL` config)" |
| `CMD_SAML_DISABLEREQUESTEDAUTHNCONTEXT` | `true` or `false` | true to allow any authentication method, false restricts to password authentication (PasswordProtectedTransport) method (default: false) |
| `CMD_SAML_IDENTIFIERFORMAT` | no example | name identifier format (optional, default: `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`) |
| `CMD_SAML_GROUPATTRIBUTE` | `memberOf` | attribute name for group list (optional) |
From 3684c65f104e8669eda7c2f76fe772fc0fd74010 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <christian@blaeul.de>
Date: Sat, 17 Aug 2019 12:14:51 +0200
Subject: [PATCH 11/12] Documentation: improved English
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
docs/configuration-env-vars.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/configuration-env-vars.md b/docs/configuration-env-vars.md
index ef7bf505f..2c4577556 100644
--- a/docs/configuration-env-vars.md
+++ b/docs/configuration-env-vars.md
@@ -35,7 +35,7 @@ defaultNotePath can't be set from env-vars
| `CMD_FORBIDDEN_NOTE_IDS` | `'robots.txt'` | disallow creation of notes, even if `CMD_ALLOW_FREEURL` is `true` |
| `CMD_IMAGE_UPLOAD_TYPE` | `imgur`, `s3`, `minio`, `lutim` or `filesystem` | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [Minio](guides/minio-image-upload.md), also there's a whole section on their respective env vars below. |
| `CMD_SOURCE_URL` | `https://github.com/codimd/server/tree/<current commit>` | Provides the link to the source code of CodiMD on the entry page (Please, make sure you change this when you run a modified version) |
-| `CMD_TOOBUSY_LAG` | `70` | CPU time for one eventloop tick until node throttles connections. (milliseconds) |
+| `CMD_TOOBUSY_LAG` | `70` | CPU time for one event loop tick until node throttles connections. (milliseconds) |
## CodiMD Location
@@ -166,7 +166,7 @@ defaultNotePath can't be set from env-vars
| variable | example value | description |
| -------- | ------------- | ----------- |
-| `CMD_OAUTH2_USER_PROFILE_URL` | `https://example.com` | where retrieve information about a user after succesful login. Needs to output JSON. (no default value) Refer to the [Mattermost](guides/auth/mattermost-self-hosted.md) or [Nextcloud](guides/auth/nextcloud.md) examples for more details on all of the `CMD_OAUTH2...` options. |
+| `CMD_OAUTH2_USER_PROFILE_URL` | `https://example.com` | Where to retrieve information about a user after successful login. Needs to output JSON. (no default value) Refer to the [Mattermost](guides/auth/mattermost-self-hosted.md) or [Nextcloud](guides/auth/nextcloud.md) examples for more details on all of the `CMD_OAUTH2...` options. |
| `CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR` | `name` | where to find the username in the JSON from the user profile URL. (no default value)|
| `CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR` | `display-name` | where to find the display-name in the JSON from the user profile URL. (no default value) |
| `CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR` | `email` | where to find the email address in the JSON from the user profile URL. (no default value) |
From d21ede4df8b1066ff5a2a11d4753f55d1c40823d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Bl=C3=A4ul?= <christian@blaeul.de>
Date: Sat, 17 Aug 2019 12:19:34 +0200
Subject: [PATCH 12/12] Documentation: improved 'Users and Privileges' section
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Christian Bläul <christian@blaeul.de>
---
docs/configuration-config-file.md | 2 +-
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 3dfb23355..39c5c2045 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 2c4577556..1f44083ed 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. |