|
| 1 | +## OpenVRE Development Setup Guide |
| 2 | + |
| 3 | +## Pre-requisites |
| 4 | + |
| 5 | +- **Docker Engine - Community** (Version: 26.1.0) |
| 6 | +- **Docker Compose** (Version: v2.26.1) |
| 7 | +You will need to have Docker Compose installed on your system. You can find instructions [here](https://docs.docker.com/compose/install/). |
| 8 | + |
| 9 | +## Cloning the Repository |
| 10 | + |
| 11 | +Clone the OpenVRE core development repository using the following command: |
| 12 | + |
| 13 | +```sh |
| 14 | + git clone https://github.com/inab/openVRE-core-dev.git |
| 15 | +``` |
| 16 | + |
| 17 | +Navigate into the cloned directory: |
| 18 | + |
| 19 | +```sh |
| 20 | +cd openVRE-core-dev |
| 21 | +``` |
| 22 | + |
| 23 | + |
| 24 | +## Setup configuration files |
| 25 | + |
| 26 | +First thing, is to create and configure your own `.env` file: |
| 27 | +``` |
| 28 | +cd openVRE-core-dev |
| 29 | +cp .env.sample .env |
| 30 | +``` |
| 31 | + |
| 32 | +Edit the new `.env` file and adapt it to your own environment. At the moment, the default values would work in most of the systems, just make sure to setup the hostname depending on the installation environment. Examples: |
| 33 | +- `FQDN_HOST`: |
| 34 | + - For local development: `$FQDN_HOST=localhost` |
| 35 | +- `UID`: Identifier of the host user running the containers (`id`) |
| 36 | +- `GID`: Identifier of the host group running the containers (non-privileged users should belong to `docker`group) |
| 37 | +- `DOCKER_GROUP`: Identifier of the `Docker` group. |
| 38 | +- `KEYCLOAK_SECRET`: The secret for the Keycloak client. |
| 39 | + |
| 40 | +### Custom Configuration |
| 41 | + |
| 42 | +To customize the installation, you can use the provided configuration files and modify them according to your specific needs. |
| 43 | +The following configuration files are available: |
| 44 | + |
| 45 | +- `.env`: Environment variables configuration file. |
| 46 | +- `front_end/openVRE/config/globals.inc.php`: Configuration file for the front-end and back-end services (both included |
| 47 | +in the front_end service). |
| 48 | +- `docker-compose.yml`: Docker Compose configuration file. |
| 49 | + |
| 50 | + |
| 51 | +## Import container images |
| 52 | + |
| 53 | +#### Option 1: pull images |
| 54 | +You can user already build images from [GitHub Container Registry](https://github.com/mapoferri?tab=packages). |
| 55 | + |
| 56 | +#### Option 2: build images |
| 57 | +Return to the `openVRE-core-dev` folder and check the `docker-compose.yml` file before building the containers. |
| 58 | + |
| 59 | +``` |
| 60 | +cd openVRE-core-dev/ |
| 61 | +docker compose build |
| 62 | +``` |
| 63 | +Check the new images: |
| 64 | +``` |
| 65 | +docker images |
| 66 | +``` |
| 67 | + |
| 68 | +## Start the services |
| 69 | + |
| 70 | +Validate the `docker-compose.yml` file before creating and starting them with the following command: |
| 71 | +``` |
| 72 | +docker-compose --profile "local_auth" up -d |
| 73 | +``` |
| 74 | +and check the status of the resulting containers |
| 75 | +``` |
| 76 | +docker ps -a |
| 77 | +``` |
| 78 | +> For advanced system administration, such as SGE fine-tuning, Keycloak integration, or Vault setup, see [Admin-Specific Configuration](https://github.com/inab/openVRE/wiki/Admin-Guide) |
| 79 | +
|
0 commit comments