Installing Dabih

Requirements

Your own (sub) domain. Dabih needs https to function properly, in this guide we assume you own a domain and can get a certificate via Let's encrypt
An OAuth2 provider. Dabih needs some way to identify users. This provider can be Github, Google, Azure (Mircosoft) or many others.
(Optional) An SQL based database. If you do not have one dabih will use an sqlite file at the storage path.

Deploying dabih on a kubernetes cluster.

TODO

Installing dabih on bare metal.

This guide assumes you have a linux server. We currently do not provide support for Windows based systems, but installation should be similar when using Windows Subsytem for Linux(WSL).

1. Install Nodejs and npm

Visit nodejs.org to install nodejs and the npm package manager. We recommend Node.js version 18.12.x LTS.

Do not install the default apt package for nodejs, it is outdated.

Use

node --version

to comfirm nodejs was installed properly

2. Clone the repos

There are 2 seperate repos that you may need.

git clone https://gitlab.spang-lab.de/containers/dabih

The first one is the dabih API server. It contains all the logic and data handling, but has no user interface. It can be used standalone with CLI tools but we recommend you also deploy the dabih client:

git clone https://gitlab.spang-lab.de/containers/dabih-client

It contains the dabih web application and consumes the api.

3. Run the API server

Install all the dependencies

cd dabih
npm install

Generate a new root key by running

npm run rootKey

Configure the API server

Run the server by calling

npm run prod

You should now see the log output in your terminal.

4. Run the client

8. Set up caddy as reverse proxy

Institute of functional genomics-Statistical Bioinformatics

University of Regensburg

Contact/Impressum · Privacy Policy · Data Policy