From e2f7004b439f8ef581171055c2698db6abf0a515 Mon Sep 17 00:00:00 2001 From: fspreck <f.spreckelsen@indiscale.com> Date: Mon, 17 Jan 2022 16:08:53 +0100 Subject: [PATCH] DOC: Add link to diagnostics.py --- src/doc/tutorials/serverside.rst | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/src/doc/tutorials/serverside.rst b/src/doc/tutorials/serverside.rst index 172ccb36..93f0fdcf 100644 --- a/src/doc/tutorials/serverside.rst +++ b/src/doc/tutorials/serverside.rst @@ -2,17 +2,18 @@ Server Side Scripting ===================== -The administrator may store regularly needed scripts, e.g. for computing a standardized analysis, on -the same machine as the CaosDB server, "on the server side", where they can be run directly by the -server. +The administrator may store regularly needed scripts, e.g. for computing a +standardized analysis, on the same machine as the CaosDB server, "on the 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 ~~~~~~~~~~~~~ -If you have access to the server and sufficient permissions to run the script, execution is fairly -simple: +If you have access to the server and sufficient permissions to run the script, +execution is fairly simple: .. code:: python @@ -35,9 +36,12 @@ permissions and changes are logged as if they were done by you directly. Testing it ~~~~~~~~~~ -You can try this out using for example the ``diagnostics.py`` script (it 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: +You can try this out using for example the ``diagnostics.py`` script (it is part +of the `CaosDB server repository +<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 -- GitLab