diff --git a/docs/content/configuration.md b/docs/content/configuration.md index adcb724d..06ea7ab0 100644 --- a/docs/content/configuration.md +++ b/docs/content/configuration.md @@ -123,7 +123,7 @@ these are rarely used for various reasons. | `allowFreeURL` | `CMD_ALLOW_FREEURL` | **`false`** or `true` | 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). | | `requireFreeURLAuthentication` | `CMD_REQUIRE_FREEURL_AUTHENTICATION` | **`false`** or `true` | Set to require authentication for FreeURL mode style note creation. | | `disableNoteCreation` | `CMD_DISABLE_NOTE_CREATION` | **`false`** or `true` | Set to `true` to disallow any person to create notes. | -| `defaultPermission` | `CMD_DEFAULT_PERMISSION` | **`editable`**, `freely`, `limited`, `locked`, `protected` or `private` | Set notes default permission (only applied on signed-in users). | +| `defaultPermission` | `CMD_DEFAULT_PERMISSION` | **`editable`**, `freely`, `limited`, `locked`, `protected` or `private` | Set notes default permission (only applied on signed-in users). See the [permissions documentation](./references/permissions.md) | | `enableUploads` | `CMD_ENABLE_UPLOADS` | **`all`** , `registered`, `none` | Set to specify who can upload images (`all` includes guest users, `registered` restricts to registered users, `none` disables uploads completely). If not set, but both `allowAnonymous` and `allowAnonymousEdits` are `false`, this will be set to `registered`. | | `sessionName` | | **`connect.sid`** | Cookie session name. | | `sessionLife` | `CMD_SESSION_LIFE` | **`14 * 24 * 60 * 60 * 1000`**, `1209600000` (14 days) | Cookie session life time in milliseconds. | diff --git a/docs/content/images/icons/hand-paper-o.svg b/docs/content/images/icons/hand-paper-o.svg new file mode 100644 index 00000000..603d9827 --- /dev/null +++ b/docs/content/images/icons/hand-paper-o.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/content/images/icons/id-card.svg b/docs/content/images/icons/id-card.svg new file mode 100644 index 00000000..542abf82 --- /dev/null +++ b/docs/content/images/icons/id-card.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/content/images/icons/leaf.svg b/docs/content/images/icons/leaf.svg new file mode 100644 index 00000000..76c70125 --- /dev/null +++ b/docs/content/images/icons/leaf.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/content/images/icons/lock.svg b/docs/content/images/icons/lock.svg new file mode 100644 index 00000000..acf155e7 --- /dev/null +++ b/docs/content/images/icons/lock.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/content/images/icons/pencil.svg b/docs/content/images/icons/pencil.svg new file mode 100644 index 00000000..55db2c87 --- /dev/null +++ b/docs/content/images/icons/pencil.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/content/images/icons/umbrella.svg b/docs/content/images/icons/umbrella.svg new file mode 100644 index 00000000..25dda9eb --- /dev/null +++ b/docs/content/images/icons/umbrella.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/content/references/permissions.md b/docs/content/references/permissions.md new file mode 100644 index 00000000..6d452e26 --- /dev/null +++ b/docs/content/references/permissions.md @@ -0,0 +1,23 @@ +# Permissions + +HedgeDoc 1.x uses a basic permission system that differentiates between the owner of a note (the account who initially +created it), logged-in users and guests. + +It is possible to change the access permission of a note through the little button on the top right of the view pane +in the editor. However, only the note owner can change the permission of a note. + +The permissions are named **Freely**, **Editable**, **Limited**, **Locked**, **Protected** and **Private**. + +You can configure the default permission for new notes using the `defaultPermission` option in the `config.json` file or +`CMD_DEFAULT_PERMISSION` environment variable. + +For more information, see the [configuration documentation](../configuration.md#users-and-privileges). + +| | Permission | Owner read/write | Signed-in read | Signed-in write | Guest read | Guest write | +|:---------------------------------------------------------------------------------:|:--------------:|:----------------:|:--------------:|:---------------:|:----------:|:-----------:| +| leaf icon | **Freely** | ✔ | ✔ | ✔ | ✔ | ✔ | +| pencil icon | **Editable** | ✔ | ✔ | ✔ | ✔ | ✖ | +| id card icon | **Limited** | ✔ | ✔ | ✔ | ✖ | ✖ | +| lock icon | **Locked** | ✔ | ✔ | ✖ | ✔ | ✖ | +| umbrella icon | **Protected** | ✔ | ✔ | ✖ | ✖ | ✖ | +| hand icon | **Private** | ✔ | ✖ | ✖ | ✖ | ✖ | diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 1654e305..3f26695f 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -42,6 +42,7 @@ nav: - 'Slide Options': references/slide-options.md - 'URL Scheme': references/url-scheme.md - 'YAML Metadata': references/yaml-metadata.md + - 'Permissions': references/permissions.md - Developer: - 'Getting Started': dev/getting-started.md - API: dev/api.md