Skip to content
Snippets Groups Projects

Document server code structure

Merged Daniel Hornung requested to merge f-doc-structure into dev
Files
55
@@ -19,18 +19,21 @@ In each of these directories, the server looks for the following files:
@@ -19,18 +19,21 @@ In each of these directories, the server looks for the following files:
``server.conf``
``server.conf``
General server configuration options. The possible configuration options are documented inside
General server configuration options. The possible configuration options are documented inside
the `default file <https://gitlab.com/caosdb/caosdb-server/-/blob/dev/conf/core/server.conf>`_.
the `default file
 
<https://gitlab.indiscale.com/caosdb/src/caosdb-server/-/blob/dev/conf/core/server.conf>`__.
``global_entity_permissions.xml``
``global_entity_permissions.xml``
:ref:`Permissions <concepts:Permissions>` which are automatically set, based on user roles.
:doc:`Permissions<../Permissions>` which are automatically set, based on user roles. See the
See the `default file <https://gitlab.com/caosdb/caosdb-server/-/blob/dev/conf/core/global_entity_permissions.xml>`_.
`default file
 
<https://gitlab.indiscale.com/caosdb/src/caosdb-server/-/blob/dev/conf/core/global_entity_permissions.xml>`__.
``usersources.ini``
``usersources.ini``
This file defines possible sources which are checked when a user tries to authenticate. Each
This file defines possible sources which are checked when a user tries to authenticate. Each
defined source has a special section, the possible options are defined separately for each user
defined source has a special section, the possible options are defined separately for each user
source. At the moment the best place to look for this specific documentation is at the API
source. At the moment the best place to look for this specific documentation is at the API
documentation of :java:type:`UserSource` and its implementing classes. The provided `template
documentation of :java:type:`UserSource` and its implementing classes. The provided `template
file <https://gitlab.com/caosdb/caosdb-server/-/blob/dev/conf/core/usersources.ini.template>`_
file
 
<https://gitlab.indiscale.com/caosdb/src/caosdb-server/-/blob/dev/conf/core/usersources.ini.template>`__
also has some information. The general concept about authentication realms is described in
also has some information. The general concept about authentication realms is described in
:java:type:`UserSources`.
:java:type:`UserSources`.
@@ -38,13 +41,13 @@ In each of these directories, the server looks for the following files:
@@ -38,13 +41,13 @@ In each of these directories, the server looks for the following files:
Configuration for dispensed authentication tokens, which can be used to authenticate to CaosDB
Configuration for dispensed authentication tokens, which can be used to authenticate to CaosDB
without the need of a user/password combination. Possible use cases are server-side scripts or
without the need of a user/password combination. Possible use cases are server-side scripts or
initial setup after the server start. There is more documentation inside the `template file
initial setup after the server start. There is more documentation inside the `template file
<https://gitlab.com/caosdb/caosdb-server/-/blob/dev/conf/core/authtoken.example.yaml>`_.
<https://gitlab.indiscale.com/caosdb/src/caosdb-server/-/blob/dev/conf/core/authtoken.example.yaml>`__.
``cache.ccf``
``cache.ccf``
Configuration for the Java Caching System (JCS) which can be used by the server. More
Configuration for the Java Caching System (JCS) which can be used by the server. More
documentation is `upstream
documentation is `upstream
<http://commons.apache.org/proper/commons-jcs/getting_started/intro.html>`_ and inside `the file
<http://commons.apache.org/proper/commons-jcs/getting_started/intro.html>`_ and inside `the file
<https://gitlab.com/caosdb/caosdb-server/-/blob/dev/conf/core/cache.ccf>`_.
<https://gitlab.indiscale.com/caosdb/src/caosdb-server/-/blob/dev/conf/core/cache.ccf>`_.
``log4j2-default.properties``, ``log4j2-debug.properties``
``log4j2-default.properties``, ``log4j2-debug.properties``
Configuration for logging, following the standard described by the `log4j library
Configuration for logging, following the standard described by the `log4j library
Loading