Skip to content
Snippets Groups Projects
Commit e2f7004b authored by Florian Spreckelsen's avatar Florian Spreckelsen
Browse files

DOC: Add link to diagnostics.py

parent 6840d5e0
No related branches found
No related tags found
1 merge request!39DOC: add doc on serverside
Pipeline #18136 failed
This commit is part of merge request !39. Comments created here will be created in the context of that merge request.
...@@ -2,17 +2,18 @@ ...@@ -2,17 +2,18 @@
Server Side Scripting Server Side Scripting
===================== =====================
The administrator may store regularly needed scripts, e.g. for computing a standardized analysis, on The administrator may store regularly needed scripts, e.g. for computing a
the same machine as the CaosDB server, "on the server side", where they can be run directly by the standardized analysis, on the same machine as the CaosDB server, "on the server
server. side", where they can be run directly by the server.
The execution of those scripts can be initiated using the Python client, or the web interface. The execution of those scripts can be initiated using the Python client, or the
web interface.
Call a Script Call a Script
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
If you have access to the server and sufficient permissions to run the script, execution is fairly If you have access to the server and sufficient permissions to run the script,
simple: execution is fairly simple:
.. code:: python .. code:: python
...@@ -35,9 +36,12 @@ permissions and changes are logged as if they were done by you directly. ...@@ -35,9 +36,12 @@ permissions and changes are logged as if they were done by you directly.
Testing it Testing it
~~~~~~~~~~ ~~~~~~~~~~
You can try this out using for example the ``diagnostics.py`` script (it is also available on You can try this out using for example the ``diagnostics.py`` script (it is part
https://demo.indiscale.com). The script returns information about the server in JSON format. You can of the `CaosDB server repository
do for example the following: <https://gitlab.indiscale.com/caosdb/src/caosdb-server/-/blob/main/scripting/bin/administration/diagnostics.py>`_
and is also available on https://demo.indiscale.com). The script returns
information about the server in JSON format. You can do for example the
following:
.. code:: python .. code:: python
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment