diff --git a/README_SETUP.md b/README_SETUP.md index a264669cf08c61686a064d96f66c0548f94c2ce8..6bbbd71167a9243966f88b29c82184600bcaa25a 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -84,8 +84,8 @@ server: `caosdb-mysqlbackend` repository 5. Create an authtoken config (e.g. copy `conf/core/authtoken.example.yaml` to `conf/ext/authtoken.yml` and change it) -6. Copy `conf/core/server.conf` to `conf/ext/server.conf` and change it - appropriately: +6. If any of the settings in `conf/core/server.conf` do not fit your needs, create + `conf/ext/server.conf` and add settings as required: * Setup for MySQL back-end: specify the fields `MYSQL_USER_NAME`, `MYSQL_USER_PASSWORD`, `MYSQL_DATABASE_NAME`, and `MYSQL_HOST`. diff --git a/src/doc/permissions.rst b/src/doc/permissions.rst index e61ee49a948e905f1800ee5fdb2f0efb6a4ab207..c0f30a0ee05d6cc8cac237b305e63b2c83ec7dce 100644 --- a/src/doc/permissions.rst +++ b/src/doc/permissions.rst @@ -5,9 +5,7 @@ CaosDB has a fine grained role based permission system. Each interaction with the server is governed by the current rules of the user, by default this is the ``anonymous`` role. The permissions for an action which involves one or more objects are set either manually or via default -permissions which can be configured. For more detailed information, -there is separate -:doc:``documentation of the permission system<permissions>``. +permissions which can be configured. Permissions are needed to perform particular elementary *actions* during any interaction with the the server. E.g. retrieving an Entity requires @@ -87,11 +85,11 @@ How to set permissions various files which use the permission API: - The `example - file <https://gitlab.com/caosdb/caosdb-pylib/blob/HEAD/examples/set_permissions.py>`__ + file <https://gitlab.com/caosdb/caosdb-pylib/-/blob/main/examples/set_permissions.py>`__ - The ```caosdb_admin.py`` utility - script <https://gitlab.com/caosdb/caosdb-pylib/blob/HEAD/src/caosdb/utils/caosdb_admin.py>`__ + script <https://gitlab.com/caosdb/caosdb-pylib/-/blob/main/src/caosdb/utils/caosdb_admin.py>`__ - The `integration - tests <https://gitlab.com/caosdb/caosdb-pyinttest/blob/HEAD/tests/test_permissions.py>`__ + tests <https://gitlab.com/caosdb/caosdb-pyinttest/-/blob/main/tests/test_permissions.py>`__ also cover quite a bit of the permission API. - WebUI :: Not implemented (or documented?) yet.