diff --git a/docs/getting-started.md b/docs/getting-started.md index 130e1a1efc4ae092a2eb4bf383896365d4552222..8fe91670eb9ae416441cc3237c3cae4818526ed4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -45,7 +45,7 @@ And the following minimal software packages to operate the repository: dnf install make ``` -## Repository +## Deployment Next, clone the source code repository into your working directory: @@ -67,8 +67,59 @@ The system is auto-configured for a small, local, test deployment. You only need docker-compose up ``` -<style> - .md-content__button { - display: none; - } -</style> \ No newline at end of file +!!! bug "Some environments need additional configuration" + + In some cluster environments, it is necessary to set Docker's MTU to the main interface MTU. Find out by executing + + ```console + nmcli -f GENERAL device show eth0 | grep "MTU" + ``` + + Having the wrong MTU set leads to the containers to not downloading the Maven dependencies and the containers are + stuck. This can quickly be solved through setting the correct MTU (e.g. 1450). + + ```json title="/etc/docker/daemon.json" + { + "mtu": 1450 + } + ``` + +## Development + +We invite all open-source developers to help us fixing bugs and introducing features to the source code. Get involved by +sending a mail to Prof. [Andreas Rauber](mailto:andreas.rauber@tuwien.ac.at) +and Proj.Ass. [Martin Weise](mailto:martin.weise@tuwien.ac.at). Clone the repository and create a feature branch +from `dev` and implement your changes. + +## Requirements + +We develop all packages with the following software requirements: + +1. [Java OpenJDK](https://openjdk.java.net/) 11 +2. [Maven](https://maven.apache.org/) 3.0.0+ +3. [Node.js](https://nodejs.org/en/) 14+ +3. [Yarn](https://yarnpkg.com/getting-started/install#nodejs-1610-1) 1.21.0+ +4. [Postgres](https://www.postgresql.org/) 12+ +5. [MariaDB](https://mariadb.org/) 10+ + +## Building + +For local development you need to install the entities from the metadata database and the general DTOs that are +exchanged between the services by installing the package: + +```console +mvn -f ./fda-metadata-db/pom.xml clean install +``` + +All other services depend on this package. You have to build them later: + +```console +mvn -f ./fda-container-service/pom.xml clean package -DskipTests +... +``` + +Conviniently, you can build them all through [`make`](https://www.gnu.org/software/make/): + +```console +make build-backend +``` \ No newline at end of file diff --git a/docs/images/favicon.png b/docs/images/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..d53b2bc9810716b1c363cf6f4304720b0f6b10a4 Binary files /dev/null and b/docs/images/favicon.png differ diff --git a/docs/images/logo.png b/docs/images/logo.png index 8ed93f837d93765c70d6c521ece6a7df22842a62..8c776cad97d7e0adc56c6e08ef691dbb4e13a543 100644 Binary files a/docs/images/logo.png and b/docs/images/logo.png differ diff --git a/docs/images/logo.psd b/docs/images/logo.psd index 2c4c82cf515772a444a12bfa38fe18846a6fcbcc..10d0fe088f59777230e9899d06819abda2ee00b9 100644 Binary files a/docs/images/logo.psd and b/docs/images/logo.psd differ diff --git a/docs/index.md b/docs/index.md index e46315caab72f43e3e48db710a738098430e5980..ce97b83ad0d542bcb36ccbb37fe6c57eabf48c29 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,16 +9,19 @@ hide: ## Problem Statement +Having a rich history, digital repositories see themselves more frequently encountered with the problem of making +databases accessible in their collection. Challenges revolve around organizing, searching and retrieving content stored +within databases and constitute a major technical burden as their internal representation greatly differs from static +documents most digital repositories are designed for. + ## Application Areas +We present a database repository system that allows researchers to ingest data into a central, versioned repository +through common interfaces, provides efficient access to arbitrary subsets of data even when the underlying data store is +evolving, allows reproducing of query results and supports findable-, accessible-, interoperable- and reusable data. + [Get Started](/getting-started){ .action-button .md-button .md-button--primary } ## Demo -Public demonstration instance [https://dbrepo.ossdip.at](https://dbrepo.ossdip.at) - -<style> - .md-content__button { - display: none; - } -</style> \ No newline at end of file +Public demonstration instance [https://dbrepo.ossdip.at](https://dbrepo.ossdip.at) \ No newline at end of file diff --git a/docs/operation.md b/docs/operation.md index a1ce8736ccf5fb86fab8640f4d2377646e26ee0f..f42b701d78149b4c231554dc1f1eb9d4d62ee9e4 100644 --- a/docs/operation.md +++ b/docs/operation.md @@ -16,9 +16,3 @@ docker-compose build fda-metadata-database docker-compose build --parallel docker-compose -f docker-compose.prod.yml up -d ``` - -<style> - .md-content__button { - display: none; - } -</style> \ No newline at end of file diff --git a/docs/publications.md b/docs/publications.md index eca7941c31aaf7578410fd904329aa86c5fa1444..f15f0f4bd61ddc56afcdf2eecef77e9ddc2adfda 100644 --- a/docs/publications.md +++ b/docs/publications.md @@ -16,11 +16,9 @@ hide: ### News -1. Gergely, E., 2021. Better Support for Research: Current Cooperation Projects. [Online]. - URL: [https://zid.univie.ac.at/it-news/artikel/news/cluster-forschungsdaten/](https://zid.univie.ac.at/it-news/artikel/news/cluster-forschungsdaten/), accessed 2022-04-12 - -<style> - .md-content__button { - display: none; - } -</style> \ No newline at end of file +1. Staudinger, M., 2022. DBRepo: A Repository to Save Research Databases. [Online]. + URL: [https://www.tuwien.at/en/tu-wien/news/news-articles/news/dbrepo](https://www.tuwien.at/en/tu-wien/news/news-articles/news/dbrepo) + accessed 2022-04-12 +2. Gergely, E., 2021. Better Support for Research: Current Cooperation Projects. [Online]. + URL: [https://zid.univie.ac.at/it-news/artikel/news/cluster-forschungsdaten/](https://zid.univie.ac.at/it-news/artikel/news/cluster-forschungsdaten/) + accessed 2022-04-12 diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index a325fac833b630fa256d93ee597ad58170963393..858d47c99048739b2e64a5a3c0c7e07de44549d4 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -1,5 +1,6 @@ [data-md-color-scheme="default"] { --md-primary-fg-color: #ff5522; + --md-accent-fg-color: #332f95; } [data-md-color-scheme="slate"] { diff --git a/docs/system.md b/docs/system.md index 5b4dba8e8cc143c6338865532105291385dd4043..d6d5d5702cf33bb7a5579acb2208f09ca16a8f12 100644 --- a/docs/system.md +++ b/docs/system.md @@ -13,9 +13,3 @@ hide: We use Docker for deployment. The containers are packing all runtime dependencies, when starting them all necessary files are already present. For running the infrastructure we use Docker Compose. - -<style> - .md-content__button { - display: none; - } -</style> \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 7b2704fee00cf971f51c3f0fe6ff0b03e12b3812..3d15188b649bcd544b05df293277bd61f3c0154e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,15 +1,17 @@ site_name: Database Repository -repo_url: https://github.com/fair-data-austria/dbrepo.git +repo_url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services repo_name: Repository -site_author: TU Wien Research Data Management -copyright: CC BY 4.0 TU Wien Research Data Management +site_author: FAIR Data Austria +copyright: CC BY 4.0 FAIR Data Austria extra: homepage: https://dbrepo.tuwien.ac.at social: - - icon: fontawesome/brands/github - link: https://github.com/fair-data-austria/dbrepo.git + - icon: fontawesome/brands/gitlab + link: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services - icon: fontawesome/brands/twitter link: https://twitter.com/RDMTUWien + - icon: fontawesome/solid/globe + link: https://forschungsdaten.at/fda/ version: provider: mike default: stable