Skip to content
Maria Paola Ferri edited this page Nov 27, 2025 · 50 revisions

openVRE Documentation

openVRE provides a modular, extensible Virtual Research Environment framework for integrating tools, workflows, and data repositories within collaborative scientific infrastructures.


Overview
 1.1 What is OpenVRE
 1.2 Key Features
 1.3 Benefits of OpenVRE
 1.4 Architecture
 1.5 Core Components
 1.6 Supported Technologies

Using openVRE
 2.1 Installation & Access
  2.1.1 Installation Guide
 2.2 User Interface Overview
 2.3 Data and Repository Management
  2.3.1 Working with External Data Repositories
  2.3.2 Uploading and Organizing Data
 2.4 Running Tools and Workflows
  2.4.1 Monitoring Executions
  2.4.2 Viewing Results and Outputs
 2.5 Visualization and Results
  2.5.1 Visualizers
  2.5.2 Common Visualizer Examples

Developing and Administering OpenVRE
 3.1 Core Configuration and Setup
  3.1.1 Apply Manual SGE Configuration
   • sgecore username
   • sgecore Docker usage permissions
  3.1.2 Keycloak Configuration
  3.1.3 HashiCorp Vault Configuration
   • Keycloak Integration for Vault
   • Vault GUI Unseal
   • Vault Manual Unseal
   • Vault Manual Setup
 3.2 Tools Integration
  3.2.1 Tools Overview
  3.2.2 Types of Tools
  3.2.3 How to Bring Your Own Tool
  3.2.4 Register a New Tool
  3.2.5 Register a New Interactive Tool
 3.3 Repositories and Resources
  3.3.1 Repository Interfaces
  3.3.2 Supported Repository Interfaces
  3.3.3 Puggable Resources
 3.4 Sites and Linked Accounts
  3.4.1 Register a New Linked Site
  3.4.2 Adding a new data repository
 3.5 Graphic and UI Extensions
  3.5.1 Graphic configuration
  3.5.2 Extending Frontend Components

Additional Resources
 4.1 FAQ
 4.2 Troubleshooting
 4.3 Citation and Acknowledgements
 4.4 License


Installation

Refer to the Installation Guide for detailed steps on setting up OpenVRE in your environment.

Clone this wiki locally