Skip to content

About

Backend for the MIP portal

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

License DockerHub

Backend for the MIP platform

DEV Deployment

To run the backend using an IDE for development, such as IntelliJ, you need a running instance of PostgreSQL.

Deployment (using a Docker image)

Build the image: docker build -t hbpmip/platform-backend:testing .

To use this image, you need a running instance of PostgreSQL and to configure the software using the following environment variables.

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".

AUTHENTICATION

  • AUTHENTICATION: true for production, false for development.
  • authentication.all_analyses_allowed_claim: defaults to the existing external authority research_experiment_all. Preserve that authority and existing grants.

DATABASE CONFIGURATION

  • PLATFORM_DB_URL: JDBC URL to connect to the platform database, default value is "jdbc:postgresql://127.0.0.1:5432/platform".
  • PLATFORM_DB_SCHEMA: Database schema, default value is "public".
  • PLATFORM_DB_USER: User to use when connecting to the platform database, default value is "postgres".
  • PLATFORM_DB_PASSWORD: Password to use when connecting to the platform database.

EXTERNAL SERVICES

ANALYSES

  • ANALYSIS_RUN_DRAFT_TTL: How long an unsaved studio run can still be saved without re-running it, as an ISO-8601 duration. Default is "PT24H".

The backend uses Analysis, Study, and Analysis Group terminology. See the module index for API and persistence details. Run mvn test, mvn -Ppostgres-integration verify against a disposable PostgreSQL database, and mvn clean package; connection settings are in the testing guide.

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.
  • KEYCLOAK_CLI_CLIENT_ID: Public Keycloak client (device flow) for mip login on users' own computers. Empty (default): not offered.

Acknowledgement

This project/research received funding from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Framework Partnership Agreement No. 650003 (HBP FPA).

About

Backend for the MIP portal

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages