diff --git a/CHANGELOG.md b/CHANGELOG.md index ab1f09f09dbc7d324e52055503545a4677fc0d40..ca41b8287dba890cdeadabcf4886aa3f3308bfd2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,6 +28,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Deprecated +* Legacy XML/HTTP API (also known as the REST API). The API will not be removed + until the web interface (caosdb-webui) and the python client libraries have + been updated and freed from any dependencies. However, new clients should not + implement this API anymore. + ### Removed ### Fixed diff --git a/DEPENDENCIES.md b/DEPENDENCIES.md index 6159dcd8f0ed2296e2f3ac992830f03659d1a131..2f2967d0e835abc882650356ab2cf0c29bd9db47 100644 --- a/DEPENDENCIES.md +++ b/DEPENDENCIES.md @@ -1,5 +1,30 @@ -* caosdb-mysqlbackend == 5.0.0 -* Java 11 -* Apache Maven >= 3.6.0 -* make >= 4.2.0 +# Dependencies + +## For Building and Running the Server + +* `>=caosdb-proto 0.1.0` +* `>=caosdb-mysqlbackend 5.0.0` +* `>=Java 11` +* `>=Apache Maven 3.6.0` +* `>=Make 4.2` +* `libpam` (if PAM authentication is required) * More dependencies are being pulled and installed automatically by Maven. See the complete list of dependencies in the [pom.xml](pom.xml) + +## For Deploying a Web User Interface (optional) + +* `>=caosdb-webui 0.4.` + +## For Building the Documentation (optional) + +* `>=Python 3.8` +* `>=pip 21.0.0` + +## For Server-side Scripting (optional) + +* `>=Python 3.8` +* `>=pip 21.0.0` +* `openpyxl` (for XLS/ODS export) + +## Recommended Packages + +* `openssl` (if a custom TLS certificate is required) diff --git a/FEATURES.md b/FEATURES.md new file mode 100644 index 0000000000000000000000000000000000000000..a5341f355fb67d0ca05e82642840789aac43bb45 --- /dev/null +++ b/FEATURES.md @@ -0,0 +1,21 @@ +# Features + +* The CaosDB Server implements a CaosDB GRPC API Endpoint (v0.1.0) + Authentication is supported via a Basic scheme, using the well-known + "authentication" header. + Notable limitations of the current implementation of the API: + * It is currently not possible to mix retrievals + (caosdb.entity.v1.RetrieveRequest) with any other transaction type - so + transaction are either read-only or write-only. The server throws an error + if it finds mixed read/write transactions. + * It is currently not possible to have more that one query + (caosdb.entity.v1.Query) in a single transaction. The server throws an + error if it finds more than one query. +* Legacy XML/HTTP API (Deprecated) +* Deployment of caosdb-webui (>=v0.4.1) +* Server-side Scripting API (v0.1) +* CaosDB Query Language Processor +* CaosDB FileSystem +* User Management, Authentication and Authorization + * Internal authentication service + * Authentication via an external service. diff --git a/README_SETUP.md b/README_SETUP.md index d738ad13768df8878b55808e4519202fc95dbd86..5065e3383c4ac2f2d549bfedb15687d0b4124ec0 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -5,26 +5,7 @@ more. ## Requirements -### CaosDB Packages - -* caosdb-webui=0.2.1 -* caosdb-mysqlbackend=3.0 - -### Third-party Software - -* `>=Java 8` -* `>=Apache Maven 3.0.4` -* `>=Python 3.4` -* `>=pip 9.0.1` -* `>=git 1.9.1` -* `>=Make 3.81` -* `>=Screen 4.01` -* `>=MySQL 5.5` (better `>=5.6`) or `>=MariaDB 10.1` -* `libpam` (if PAM authentication is required) -* `unzip` -* `openpyxl` (for XLS/ODS export) -* `openssl` (if a custom TLS certificate is required) -- `easy-units` >= 0.0.1 https://gitlab.com/timm.fitschen/easy-units +See [DEPENDENCIES.md](DEPENDENCIES.md). #### Install the requirements on Debian diff --git a/RELEASE_GUIDELINES.md b/RELEASE_GUIDELINES.md index 5c1fd68d462212e9b81dbc803fc590006df36a3d..4b9185323d3b6fdafbd049e7c68273c909de5a05 100644 --- a/RELEASE_GUIDELINES.md +++ b/RELEASE_GUIDELINES.md @@ -31,3 +31,5 @@ guidelines of the CaosDB Project 8. Update the version property in [pom.xml](./pom.xml) for the next developlement round (with a `-SNAPSHOT` suffix). + +9. Add a gitlab release in the respective repository. diff --git a/src/doc/DEPENDENCIES.md b/src/doc/DEPENDENCIES.md new file mode 120000 index 0000000000000000000000000000000000000000..28771e4dc45403b9c9baa795f04584e5b0a283ec --- /dev/null +++ b/src/doc/DEPENDENCIES.md @@ -0,0 +1 @@ +../../DEPENDENCIES.md \ No newline at end of file diff --git a/src/doc/index.rst b/src/doc/index.rst index 21fd891c083e7932d8b342d93992b2d02158364e..67a9e365f506009da21b3a6c00b771e751bf26c0 100644 --- a/src/doc/index.rst +++ b/src/doc/index.rst @@ -13,6 +13,7 @@ Welcome to caosdb-server's documentation! Query Language <CaosDB-Query-Language> administration Development <development/devel> + Dependencies <DEPENDENCIES> specification/index.rst Glossary API documentation<_apidoc/packages>