From 687c0137c1eefbd23ba96dff9e0185d029866ea2 Mon Sep 17 00:00:00 2001 From: Timm Fitschen <t.fitschen@indiscale.com> Date: Thu, 5 Aug 2021 23:38:32 +0200 Subject: [PATCH] REVIEW: fixes some minor referencing issues --- src/doc/administration/configuration.rst | 14 +++++++++----- src/doc/roles.md | 4 ++-- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/src/doc/administration/configuration.rst b/src/doc/administration/configuration.rst index f8a9e436..c91ac16b 100644 --- a/src/doc/administration/configuration.rst +++ b/src/doc/administration/configuration.rst @@ -1,6 +1,8 @@ -# Server Configuration +Server Configuration +==================== -## Main Configuration File +Main Configuration File +----------------------- The server is configured through configuration files. The main file is the `server.conf`. @@ -29,12 +31,13 @@ The default configuration can be overriden by in this order. -## Further Configuration Files +Further Configuration Files +--------------------------- Further settings are to be set in files which are by default stored in `./conf/core/`: ``global_entity_permissions.xml`` - :doc:`Permissions<../Permissions>` which are automatically set, based on user roles. See the + :doc:`Permissions<../permissions>` which are automatically set, based on user roles. See the `default file <https://gitlab.indiscale.com/caosdb/src/caosdb-server/-/blob/dev/conf/core/global_entity_permissions.xml>`__. @@ -71,7 +74,8 @@ The administrator may set the corresponding options in the main configuration file (`./conf/core/server.conf` and it's friends) to replace these special files with custom configuration. -## Changing the configuration at runtime +Changing the configuration at runtime +------------------------------------- Remark: Only when the server is in debug mode, the general configuration can be changed at runtime. diff --git a/src/doc/roles.md b/src/doc/roles.md index 5f4641b7..2d1d36c4 100644 --- a/src/doc/roles.md +++ b/src/doc/roles.md @@ -10,7 +10,7 @@ users may have the same role, and there may be roles without any users. The user and their roles are always returned by the server in answers to requests and can thus be interpreted and used by clients. The most important use though -is [permission](Permissions) checking in the server: Access and +is [permission](doc:`permissions`) checking in the server: Access and modification of entities can be controlled via roles, so that users of a given role are allowed or denied certain actions. Incidentally, the permission to edit the permissions @@ -32,4 +32,4 @@ There are some special roles, which are automatically assigned to users: Except for the `anonymous` role, these special roles are not returned by the server, but can nevertheless be used to define -[permissions](Permissions). +[permissions](doc:`permissions`). -- GitLab