Skip to content
Snippets Groups Projects
Verified Commit 0e568eca authored by Martin Weise's avatar Martin Weise
Browse files

Updated readme and updated last docs

parent 7c45d813
No related branches found
No related tags found
3 merge requests!231CI: Remove build for log-service,!228Better error message handling in the frontend,!223Release of version 1.4.0
...@@ -19,15 +19,18 @@ curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-service ...@@ -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 For this small, local, test deployment any modern hardware would suffice, we recommend a dedicated virtual machine with
the following settings. 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" !!! tip "Resource Consumption"
Note that most of the vCPU and RAM resources will be needed for starting the infrastructure, this is because of 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. Docker. During operation and especially idle times, the deployment will use significantly less resources.
- 8 vCPU cores
- 16GB RAM memory
- 100GB SSD storage
### Software ### Software
We only test the Docker Compose deployment with the We only test the Docker Compose deployment with the
......
[![pipeline status](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/pipeline.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master) [![pipeline status](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/pipeline.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master)
[![coverage report](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/coverage.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master) [![coverage report](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/coverage.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master)
[![license](.gitlab/license.svg)](https://opensource.org/licenses/Apache-2.0) [![license](.gitlab/license.svg)](https://opensource.org/licenses/Apache-2.0)
[![release](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/badges/release.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/tags)
![DBREPO &mdash; Repository for Data in Databases](./dbrepo-ui/static/logo.png) <img src="./dbrepo-ui/static/logo.png" alt="DBREPO &mdash; 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 ## 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 ## Contribute
Contributions are always welcome and encouraged, please read the [contribution overview](./CONTRIBUTING.md) and 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 ## Acknowledgements
...@@ -20,10 +31,10 @@ We want to thank the following organizations: ...@@ -20,10 +31,10 @@ We want to thank the following organizations:
* Bundesministerium für Bildung, Wissenschaft und Forschung (BMBWF) for funding during * 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) 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". "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 * [TU.it &amp; .digital office](https://www.it.tuwien.ac.at/en/) for their continuous support in project
provided in-kind. work, [funding](https://www.tuwien.at/tu-wien/organisation/zentrale-bereiche/digital-office/projekte/dcall-2023-projekte)
and compute resources provided in-kind.
## License ## License
This work is licensed under The source code is licensed under [Apache 2.0](https://opensource.org/licenses/Apache-2.0).
a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/) \ No newline at end of file
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment