From cc839442c95d1b9f1afff290cc49fffed9fda627 Mon Sep 17 00:00:00 2001 From: Robert Butora <robert.butora@inaf.it> Date: Sat, 1 Mar 2025 15:59:05 +0100 Subject: [PATCH] README: updates (explicit on what is mandataory/optional) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b2eb082..589d37b 100644 --- a/README.md +++ b/README.md @@ -20,18 +20,18 @@ curl --get http://localhost:8004/vlkb/datasets/availability - **availability** is a [VOSI](https://ivoa.net/documents/VOSI/20170524/REC-VOSI-1.1.html) end-point and returns information whether the service is active - **capabilities** is a [VOSI](https://ivoa.net/documents/VOSI/20170524/REC-VOSI-1.1.html) end-point which describes service' functions and paramters - **sync** synchronous end-point provides [SODA](https://ivoa.net/documents/SODA/20170517/index.html) service -- **async/uws** (optional) asynchronous endpoint [UWS](https://ivoa.net/documents/UWS/20161024/REC-UWS-1.1-20161024.html#ApplicationsOfUWS) which provides *mcutout*: a non-standard service which allows several cuts to be specified in one request by a [Job Description Language](JDL.md). All cuts are returned in one compressed file. +- **async/uws** (optional) asynchronous [UWS](https://ivoa.net/documents/UWS/20161024/REC-UWS-1.1-20161024.html#ApplicationsOfUWS) endpoint which provides *mcutout*: a non-standard service which allows several cuts to be specified in one request by a [Job Description Language](JDL.md). All cuts are returned in one compressed file. ## Docker image is available from the gitlab-repository of this project. -SODA-docker's internal mount point for the FITS-files storage is **/srv/datasets** (read-only). +SODA-docker's internal mount point for the FITS-files storage is **/srv/datasets** (read-only); which is the only mandatory element. The rest of configuration is optional. SODA-docker's internal mount point which temporarely holds cut files is **/srv/cutouts** (read-write) for **mcutout only**. -Configuration parameters are set by these docker environment variables: +Configuration parameters, all optional: | parameter | description | |---------|--------------| -- GitLab