Open Virtual Research Environment core development (openVRE-core-dev)

OpenVRE (Open Virtual Research Environment) is an open-source, cloud-based platform designed to facilitate the creation, management and customization of Virtual Research Environments (VREs). OpenVRE bridges the gap between HPC resources, sensitive data infrastructures and analytical tools and workflows, providing a flexible environment that enables secure data access, scalable computation and collaboration.

This repository contains the source code for the openVRE core development version, which includes the core components of the platform. Other software pieces as the tools, visualizers and data are specific to the each openVRE deployment.

A production-ready version of openVRE can be found in the openVRE repository. It also includes a complete documentation of the platform at the respository wiki.

⚠️ This documentation is a work in progress and may not correspond with the production version repository documentation.

Installation

Dependencies

You will need to have Docker Compose installed on your system. You can find instructions here.

Quickstart

Before you run the installation, it is likely that you will need to change some environment variables:

• DOCKER_GROUP: The group ID for the docker group.
• KEYCLOAK_SECRET: The secret for the Keycloak client.
• UID: The user ID for the user running the services.
• GID: The group ID for the user running the services.

For a straightforward installation with default configuration, follow the steps below:

git clone https://github.com/inab/openVRE-core-dev.git

cd openVRE-core-dev

cp .env.sample .env
cp front_end/openVRE/config/globals.inc.php.sample front_end/openVRE/config/globals.inc.php

docker compose --profile "local_auth" up -d 

After the installation is complete, you can access the platform at the following URL: http://localhost:8088.

Custom Configuration

To customize the installation, you can use the provided configuration files and modify them according to your specific needs. The following configuration files are available:

• .env: Environment variables configuration file.
• front_end/openVRE/config/globals.inc.php: Configuration file for the front-end and back-end services (both included in the front_end service).
• docker-compose.yml: Docker Compose configuration file.