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

Updated the docs

parent a43a8b9b
No related branches found
No related tags found
No related merge requests found
Pipeline #5185 failed
---
author: Martin Weise
hide:
- navigation
---
# Contact
......
---
author: Martin Weise
hide:
- navigation
---
# Customization
!!! info "Abstract"
On this page, we showcase the customization capabilities of DBRepo to e.g. whitelabel your deployment.
## Logo
If you want to display your own logo instead of the placeholder logo in the UI, you need to:
<figure markdown>
![](images/custom_logo.png)
<figcaption>Custom logo which replaces the default placeholder logo.</figcaption>
</figure>
---
author: Martin Weise
hide:
- navigation
---
# Deployment
......
---
author: Martin Weise
hide:
- navigation
......@@ -16,51 +17,81 @@ hide:
### Hardware
For this small, local, test deployment any modern hardware would suffice, we recommend a machine with at least:
For this small, local, test deployment any modern hardware would suffice, we recommend a machine (or laptop) with at
least:
- 8 Cores (can be virtual cores)
- 16GB RAM
- 100GB SSD memory
- Fast internet connection
- 8 CPU cores
- 16GB RAM memory
- 100GB SSD memory available
### Software
Install [:fontawesome-brands-docker: Docker Engine](https://docs.docker.com/engine/install/) for your OS.
Install Docker Engine for your operating system. There are excellent guides available for Linux, we highly recommend
to use a stable distribution such as [Debian](https://docs.docker.com/desktop/install/debian/). In the following guide
we only consider Debian.
## Deployment
We currently maintain 14 images on [Dockerhub](https://hub.docker.com/u/dbrepo).
### Docker
### Docker Compose
We maintain a rapid prototype deployment option through Docker Compose.
=== ":fontawesome-brands-linux: Linux"
Download the
latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml)
and [`.env`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example):
curl -o docker-compose.yml \
https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml
curl -o .env \
https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example
Start the services:
docker-compose up -d
View the logs:
docker-compose logs -f
Please be warned that the default configuration is not intended for public deployments. It is only intended to have a
running system within minutes to play around within the system and explore features.
!!! warning "Known security issues with the default configuration"
The system is auto-configured for a small, local, test deployment and is *not* secure! You need to make modifications
in various places to make it secure:
Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml)
and [`.env`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example)
$ curl -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml
$ curl -o .env https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example
* **Authentication Service**:
Start the services
a. You need to use your own instance or configure a secure instance using a (self-signed) certificate.
Additionally, when serving from a non-default Authentication Service, you need to put it into the
`JWT_ISSUER` environment variable (`.env`).
$ docker-compose up -d
b. You need to change the default admin user `fda` password in Realm
master > Users > fda > Credentials > Reset password.
=== ":fontawesome-brands-apple: macOS"
c. You need to change the client secrets for the clients `dbrepo-client` and `broker-client`. Do this in Realm
dbrepo > Clients > dbrepo-client > Credentials > Client secret > Regenerate. Do the same for the
broker-client.
Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml)
and [`.env`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example)
$ curl -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml
$ curl -o .env https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example
d. You need to regenerate the public key of the `RS256` algorithm which is shared with all services to verify
the signature of JWT tokens. Add your securely generated private key in Realm
dbrepo > Realm settings > Keys > Providers > Add provider > rsa.
Start the services
* **Broker Service**: by default, this service is configured with an administrative user that has major privileges.
You need to change the password of the user *fda* in Admin > Update this user > Password. We found this
[simple guide](https://onlinehelp.coveo.com/en/ces/7.0/administrator/changing_the_rabbitmq_administrator_password.htm)
to be very useful.
$ docker-compose up -d
* **Search Service**: by default, this service is configured to require authentication with an administrative user
that is allowed to write into the indizes. Following
this [simple guide](https://www.elastic.co/guide/en/elasticsearch/reference/8.7/reset-password.html), this can be
achieved using the command line.
The system is auto-configured for a small, local, test deployment. You need to place the `.env` file in the same
directory as the `docker-compose.yml`.
* **Gateway Service**: by default, no HTTPS is used that protects the services behind. You need to provide a trusted
SSL/TLS certificate in the configuration file or use your own proxy in front of the Gateway Service. See this
[simple guide](http://nginx.org/en/docs/http/configuring_https_servers.html) on how to install a SSL/TLS
certificate on NGINX.
### Kubernetes
......
docs/images/architecture-ui.png

33.7 KiB | W: | H:

docs/images/architecture-ui.png

33.9 KiB | W: | H:

docs/images/architecture-ui.png
docs/images/architecture-ui.png
docs/images/architecture-ui.png
docs/images/architecture-ui.png
  • 2-up
  • Swipe
  • Onion skin
docs/images/architecture.png

119 KiB | W: | H:

docs/images/architecture.png

113 KiB | W: | H:

docs/images/architecture.png
docs/images/architecture.png
docs/images/architecture.png
docs/images/architecture.png
  • 2-up
  • Swipe
  • Onion skin
docs/images/custom_logo.png

64.9 KiB

docs/images/deployment-tuwien.png

69.3 KiB

docs/images/illustration.jpg

442 KiB

---
title: Home
author: Martin Weise
hide:
- navigation
---
# DBRepo: A Database Repository to Support Research
......@@ -15,6 +15,7 @@ constitute a major technical burden as their internal representation greatly dif
repositories are designed for.
[Get Started](/infrastructures/dbrepo/get-started){ .action-button .md-button .md-button--primary }
[Learn More](/infrastructures/dbrepo/system){ .action-button .md-button .md-button--secondary }
## Application Areas
......
---
author: Martin Weise
hide:
- navigation
---
# Publications
......
---
author: Martin Weise
hide:
- navigation
---
# System
......@@ -186,6 +185,12 @@ public ResponseEntity<DatabaseBriefDto> create(@NotNull Long containerId,
| `modify-user-theme` | Can modify the user theme (light, dark) |
| `modify-user-information` | Can modify the user information |
##### Escalated User Handling
| Name | Description |
|-------------|-----------------------------------------------|
| `find-user` | Can list user information for a specific user |
##### Escalated Container Handling
| Name | Description |
......
This diff is collapsed.
This diff is collapsed.
......@@ -4,14 +4,14 @@ repo_name: fda-services
site_author: Research Unit Data Science, Technische Universit&auml;t Wien
copyright: CC-BY 4.0 Technische Universit&auml;t Wien & Universit&auml;t Wien
extra:
homepage: https://dbrepo.tuwien.ac.at
homepage: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/
social:
- icon: fontawesome/brands/gitlab
link: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services
nav:
- Home: index.md
- get-started.md
- deployment.md
- customization.md
- system.md
- publications.md
- contact.md
......
mkdocs==1.3.0
mkdocs-material==8.2.9
mkdocs==1.4.3
mkdocs-material==9.1.12
mkdocs-with-pdf==0.9.3
mkdocs-material-extensions>=1.0.3
mike>=1.1.2
requests>=2.27.0
py-dotenv>=0.1
python-dotenv==0.21.0
\ No newline at end of file
python-dotenv==1.0.0
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment