Skip to content
Snippets Groups Projects
Unverified Commit aa287b37 authored by Martin Weise's avatar Martin Weise
Browse files

Added a simple, interactive, public documentation

parent ac3fd0b0
No related branches found
No related tags found
No related merge requests found
# Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml
<?xml version="1.0" encoding="UTF-8"?>
<module type="PYTHON_MODULE" version="4">
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>
\ No newline at end of file
<component name="InspectionProjectProfileManager">
<settings>
<option name="USE_PROJECT_PROFILE" value="false" />
<version value="1.0" />
</settings>
</component>
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectRootManager" version="2" project-jdk-name="Python 3.6" project-jdk-type="Python SDK" />
</project>
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/fda-docs.iml" filepath="$PROJECT_DIR$/.idea/fda-docs.iml" />
</modules>
</component>
</project>
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>
\ No newline at end of file
---
hide:
- navigation
---
# Getting Started
!!! abstract "Abstract"
In this short getting started guide we show the dependencies to run the database repository and perform a small,
local, test deployment for quickly trying out the features that the repository offers.
!!! danger "Production"
Do not use this small, local, test deployment with production data. It is not secure for production.
## Requirements
### Hardware
For this small, local, test deployment any modern hardware would suffice, we recommend a machine with at least:
- 8 Cores (can be virtual cores)
- 16GB RAM
- 100GB SSD memory
- Fast internet connection
### Software
We currently only test RPM-based operating systems. Other systems in theory should also work, but no warranty whatsoever
is given that there might be some compatibility issues in the future.
1. [Rocky Linux](https://rockylinux.org/) 8.4+
On the local machine, we need installed:
1. [Docker Engine](https://docs.docker.com/engine/install/centos/) 18.02.0+
2. [Docker Compose](https://docs.docker.com/compose/install/)
And the following minimal software packages to operate the repository:
```console
dnf install make
```
## Repository
Next, clone the source code repository into your working directory:
```console
git clone https://github.com/fair-data-austria/dbrepo.git
```
Start building the metadata database container and the remaining containers (in fast, parallel mode utilizing all cores
of your local machine):
```console
docker-compose build fda-metadata-database
docker-compose build --parallel
```
The system is auto-configured for a small, local, test deployment. You only need to start all containers by executing:
```console
docker-compose up
```
<style>
.md-content__button {
display: none;
}
</style>
\ No newline at end of file
docs/images/logo.png

4.5 KiB

File added
---
hide:
- navigation
---
# Database Repository
## Problem Statement
## Application Areas
[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
---
hide:
- navigation
---
# Operation
## Deploy
```bash
make teardown
make config-frontend # for renewing Let's Encrypt certificates
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
---
hide:
- navigation
---
# Publications
### Conferences
1. Weise, M., Michlits, C., Staudinger, M., Gergely, E., Stytsenko, K., Ganguly, R. and Rauber A., 2021. FDA-DBRepo: A
Data Preservation Repository Supporting FAIR Principles, Data Versioning and Reproducible Queries. *Proceedings of
the 17th International Conference on Digital Preservation*, Beijing, China, p.34.
DOI: [10.17605/OSF.IO/B7NX5](http://doi.org/10.17605/OSF.IO/B7NX5)
### 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
[data-md-color-scheme="default"] {
--md-primary-fg-color: #ff5522;
}
[data-md-color-scheme="slate"] {
--md-primary-fg-color: #ff5522;
--md-primary-bg-color: #2e303d;
}
\ No newline at end of file
---
hide:
- navigation
---
# System
## Architecture
### Technical
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
site_name: Database Repository
repo_url: https://github.com/fair-data-austria/dbrepo.git
repo_name: Repository
site_author: TU Wien Research Data Management
copyright: CC BY 4.0 TU Wien Research Data Management
extra:
homepage: https://dbrepo.tuwien.ac.at
social:
- icon: fontawesome/brands/github
link: https://github.com/fair-data-austria/dbrepo.git
- icon: fontawesome/brands/twitter
link: https://twitter.com/RDMTUWien
version:
provider: mike
default: stable
nav:
- Home: index.md
- getting-started.md
- system.md
- operation.md
- publications.md
extra_css:
- stylesheets/extra.css
theme:
favicon: images/favicon.png
logo: images/logo.png
font:
text: IBM Plex Sans
code: IBM Plex Mono
features:
- navigation.tabs
- navigation.tabs.sticky
icon:
repo: fontawesome/brands/git-alt
palette:
- scheme: default
font:
code: Roboto Mono
toggle:
icon: material/weather-night
name: Switch to light mode
- scheme: slate
font:
code: Roboto Mono
toggle:
icon: material/weather-sunny
name: Switch to dark mode
name: material
markdown_extensions:
- attr_list
- md_in_html
- admonition
- pymdownx.details
- pymdownx.superfences
- toc:
permalink: True
\ No newline at end of file
mkdocs-material==8.2.9
\ 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