Skip to content

Install-prod.md

Latest commit

 

History

History
59 lines (37 loc) · 1.67 KB

Install-prod.md

File metadata and controls

59 lines (37 loc) · 1.67 KB
Raw

OpenVRE Development Setup Guide

Pre-requisites

  • Docker Engine - Community (Version: 26.1.0)
  • Docker Compose (Version: v2.26.1)

Here you can find instructions to install Docker Compose.

Cloning the Repository

Clone the OpenVRE core development repository using the following command:

 git clone https://github.com/inab/openVRE.git

Navigate into the cloned directory:

cd openVRE

Configuration

First thing, is to create and configure your own .env file:

cd openVRE
cp .env.sample-prod .env

Edit the new .env file and adapt it to your own environment.

Then, do the same for the globals.inc.php file:

cp front_end/openVRE/config/globals.inc.php.sample-prod front_end/openVRE/config/globals.inc.php

Remove commented certificates from the docker-compose-prod.yml file that your instance will use (in case you use a proxy not all the certificates are required). You may use the template script generate-certs.sh to generate them.

After that, you will need to manually run some steps to set up your Vault service.

For advanced system administration, such as SGE fine-tuning, Keycloak integration, or Vault setup, see Admin-Specific Configuration.

Start the services

Run the docker-compose.yml file once you have set up your OpenVRE instance with the following command:

docker compose -f docker-compose-prod.yml --profile "local_auth" up -d

and check the status of the resulting containers:

docker ps