Skip to content
Snippets Groups Projects
README.md 2.2 KiB
Newer Older
[![CHUV](https://img.shields.io/badge/CHUV-LREN-AF4C64.svg)](https://www.unil.ch/lren/en/home.html) [![License](https://img.shields.io/badge/license-AGPL--3.0-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.html)
Mirco Nasuti's avatar
Mirco Nasuti committed
[![DockerHub](https://img.shields.io/badge/docker-hbpmip%2Fportal--backend-008bb8.svg)](https://hub.docker.com/r/hbpmip/portal-backend/)
Mirco Nasuti's avatar
Mirco Nasuti committed

# Backend for the MIP portal

ThanKarab's avatar
ThanKarab committed
## DEV Deployment
To run the backend using an IDE for development, such as IntelliJ, you need a running instance of PostgreSQL.
Mirco Nasuti's avatar
Mirco Nasuti committed

Mirco Nasuti's avatar
Mirco Nasuti committed
## Deployment (using a Docker image)
ThanKarab's avatar
ThanKarab committed
Build the image: ` docker build -t hbpmip/portal-backend:latest .`
Mirco Nasuti's avatar
Mirco Nasuti committed

ThanKarab's avatar
ThanKarab committed
To use this image, you need a running instance of PostgreSQL and to configure the software using the following environment variables.
ThanKarab's avatar
ThanKarab committed
#### LOG LEVELS ###
* LOG_LEVEL: log level for the developer added logs. Default is "ERROR".
* LOG_LEVEL_FRAMEWORK: log level for all the framework logs. Default is "ERROR".
ThanKarab's avatar
ThanKarab committed
#### AUTHENTICATION ###
* AUTHENTICATION: true for production, false for development.
ThanKarab's avatar
ThanKarab committed
#### DATABASE CONFIGURATION ###
* PORTAL_DB_URL: JDBC URL to connect to the portal database, default value is "jdbc:postgresql://127.0.0.1:5432/portal".
* PORTAL_DB_SCHEMA: Database schema, default value is "public".
* PORTAL_DB_USER: User to use when connecting to the portal database, default value is "postgres".
* PORTAL_DB_PASSWORD: Password to use when connecting to the portal database.
ThanKarab's avatar
ThanKarab committed
#### EXTERNAL SERVICES ###
* MIPENGINE_URL: URL to MIPENGINE server. Default is "http://localhost:5000" .
* EXAREME_URL: URL to Exareme server. Default is "http://localhost:9090" .
* GALAXY_URL: URL to Workflow server. Default is "http://localhost:8090/" .
* GALAXY_API_KEY: The api key to authorize galaxy requests.
* GALAXY_USERNAME: The username of galaxy user to be able to embed the frame.
* GALAXY_PASSWORD: The password of galaxy user.
ThanKarab's avatar
ThanKarab committed
#### KEYCLOAK ###
* KEYCLOAK_AUTH_URL: Keycloak authentication URL.
* KEYCLOAK_REALM: Keycloak realm user for authentication.
* KEYCLOAK_CLIENT_ID: The keycloak client id.
* KEYCLOAK_CLIENT_SECRET: The keycloak secret to be able to authenticate.

# Acknowledgements

This work has been funded by the European Union Seventh Framework Program (FP7/2007­2013) under grant agreement no. 604102 (HBP)