Skip to content
Snippets Groups Projects
Verified Commit 1d04bfbd authored by Timm Fitschen's avatar Timm Fitschen
Browse files

DOC: update README_SETUP on server-side scripting

parent a28ce4c8
No related branches found
No related tags found
No related merge requests found
...@@ -68,7 +68,7 @@ server: ...@@ -68,7 +68,7 @@ server:
needs to be an internet connection as packages are downloaded to be needs to be an internet connection as packages are downloaded to be
integrated in the java file. integrated in the java file.
1. It is recommended to run the unit tests with `make test`. It may take a 1. It is recommended to run the unit tests with `make test`. It may take a
while. while.
2. Create an SSL certificate somewhere with a `Java Key Store` file. For 2. Create an SSL certificate somewhere with a `Java Key Store` file. For
self-signed certificates (not recommended for production use) you can do: self-signed certificates (not recommended for production use) you can do:
- `mkdir certificates; cd certificates` - `mkdir certificates; cd certificates`
...@@ -95,12 +95,19 @@ server: ...@@ -95,12 +95,19 @@ server:
Make sure that the conf file is not readable by other users because the Make sure that the conf file is not readable by other users because the
certificate passwords are stored in plaintext. certificate passwords are stored in plaintext.
* Set the file system paths: * Set the file system paths:
- `FILE_SYSTEM_ROOT`: The root for all the files managed by CaosDB. - `FILE_SYSTEM_ROOT`: The root for all the files managed by CaosDB.
- `DROP_OFF_BOX`: Files can be put here for insertion into CaosDB. - `DROP_OFF_BOX`: Files can be put here for insertion into CaosDB.
- `TMP_FILES`: Temporary files go here, for example during script execution - `TMP_FILES`: Temporary files go here, for example during script
or when uploading or moving files. execution or when uploading or moving files.
- `SHARED_FOLDER`: Folder for sharing files via cryptographic tokens, also - `SHARED_FOLDER`: Folder for sharing files via cryptographic tokens,
those created by scripts. also those created by scripts.
- `SERVER_SIDE_SCRIPTING_BIN_DIRS`: A comma or white space separated list
of directories (relative of absolute) where the server will be looking
for executables which are then callable as server-side scripts. By
default this list only contains `./scripting/bin`. If you want to
include e.g. scripts which are maintained as part of the caosdb-webui
repository (because they are intended for usage by the webui), you
should add `./caosdb-webui/sss_bin/` as well.
* Maybe set another `SESSION_TIMEOUT_MS`. * Maybe set another `SESSION_TIMEOUT_MS`.
* See also [README_CONFIGURATION.md](README_CONFIGURATION.md) * See also [README_CONFIGURATION.md](README_CONFIGURATION.md)
4. Copy `conf/core/usersources.ini.template` to `conf/ext/usersources.ini`. 4. Copy `conf/core/usersources.ini.template` to `conf/ext/usersources.ini`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment