From 0e568eca8c9365287878cd5d048a47c069303d08 Mon Sep 17 00:00:00 2001
From: Martin Weise <martin.weise@tuwien.ac.at>
Date: Fri, 19 Jan 2024 11:31:48 +0100
Subject: [PATCH] Updated readme and updated last docs
---
.docs/deployment-docker-compose.md | 11 +++++++----
README.md | 25 ++++++++++++++++++-------
2 files changed, 25 insertions(+), 11 deletions(-)
diff --git a/.docs/deployment-docker-compose.md b/.docs/deployment-docker-compose.md
index c8938279ca..4e78dad081 100644
--- a/.docs/deployment-docker-compose.md
+++ b/.docs/deployment-docker-compose.md
@@ -19,15 +19,18 @@ curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-service
For this small, local, test deployment any modern hardware would suffice, we recommend a dedicated virtual machine with
the following settings.
+- min. 8 vCPU cores
+- min. 16GB RAM memory
+- min. 200GB SSD storage
+- min. 100Mbit/s connection
+
+*Optional*: public IP-address if you want to secure the deployment with a (free) TLS-certificate from Let's Encrypt.
+
!!! tip "Resource Consumption"
Note that most of the vCPU and RAM resources will be needed for starting the infrastructure, this is because of
Docker. During operation and especially idle times, the deployment will use significantly less resources.
-- 8 vCPU cores
-- 16GB RAM memory
-- 100GB SSD storage
-
### Software
We only test the Docker Compose deployment with the
diff --git a/README.md b/README.md
index db0bc5baee..4b38972edd 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,28 @@
[](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master)
[](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master)
[](https://opensource.org/licenses/Apache-2.0)
+[](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/tags)
-
+<img src="./dbrepo-ui/static/logo.png" alt="DBREPO — Repository for Data in Databases" width="200" />
+
+## tl;dr
+
+If you have [Docker](https://docs.docker.com/engine/install/) already installed on your system, you can install DBRepo
+with:
+
+```bash
+curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/install.sh | bash
+```
## Documentation
-More documentation can be found online: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/
+Find a system description, component documentation and endpoint documentation
+online: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/.
## Contribute
Contributions are always welcome and encouraged, please read the [contribution overview](./CONTRIBUTING.md) and
-contact [Andreas Rauber](http://www.ifs.tuwien.ac.at/~andi/).
+contact [Prof. Andreas Rauber](http://www.ifs.tuwien.ac.at/~andi/) or [Martin Weise](https://ec.tuwien.ac.at/~weise/).
## Acknowledgements
@@ -20,10 +31,10 @@ We want to thank the following organizations:
* Bundesministerium für Bildung, Wissenschaft und Forschung (BMBWF) for funding during
the [call](https://www.bmbwf.gv.at/Themen/HS-Uni/Aktuelles/Ausschreibung--Digitale-und-soziale-Transformation-in-der-Hochschulbildung-.html)
"Digitale und soziale Transformation in der Hochschulbildung".
-* [TU.it](https://www.it.tuwien.ac.at/en/) for their continuous support in project work, funding and compute resources
- provided in-kind.
+* [TU.it & .digital office](https://www.it.tuwien.ac.at/en/) for their continuous support in project
+ work, [funding](https://www.tuwien.at/tu-wien/organisation/zentrale-bereiche/digital-office/projekte/dcall-2023-projekte)
+ and compute resources provided in-kind.
## License
-This work is licensed under
-a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/)
\ No newline at end of file
+The source code is licensed under [Apache 2.0](https://opensource.org/licenses/Apache-2.0).
\ No newline at end of file
--
GitLab