Skip to content

About

This is a deployment example of GDI User Portal, assuming RHEL-based Linux distribution.

Resources

Code of conduct

Stars

1 star

Watchers

8 watching

Forks

Repository files navigation

REUSE status example workflow GitHub contributors Contributor Covenant

GDI User Portal

This is a deployment example of all components needed for GDI User Portal, assuming a RHEL-based Linux distribution. For REMS, the keys for issuing Visas and passports are included, follow the instructions here https://github.com/GenomicDataInfrastructure/starter-kit-rems for the complete manual.

Important

This repository cannot be used directly for production. Please ensure you have carefully reviewed all requirements and environment variables, for each component, and have put all security measurements in place.

Preparatory steps on the VM

# Install some tools
sudo dnf install git 

# Install, start and enable Docker
dnf config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
dnf install docker-ce docker-ce-cli containerd.io
sudo systemctl start docker
sudo systemctl enable docker

# You can also [create a user](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/4/html/system_administration_guide/s2-users-add)
# And [add her to a docker group](https://docs.docker.com/engine/install/linux-postinstall/) so that docker can be run without sudo.

# Configure firewall
firewall-cmd --permanent --zone=public --add-port=8443/tcp
# If you intend to run a reverse proxy on the machine as well, ensure 80/443 are open and nginx is configured to proxy connection to port 8443.

# Access to GDI Github packages 
Make sure that the VM has access to GitHub packages. Follow the manual here: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic

Installation

# Prepare the project files
mkdir -p /srv
cd /srv
git clone https://github.com/GenomicDataInfrastructure/gdi-userportal-deployment.git
cd gdi-userportal-deployment/
cp .env.example .env

Configuration

  • Check and replace sensitive values in .env;
  • Replace NGINX SSL certificates.

Running

Tracking main applies exclusively to the Dev environment. Other environments continue to use the release versions configured in their GitLab environment variables.

For Dev, GDI service images track their repositories’ main branch. Compose pulls them on each up; use build --pull to refresh the Keycloak base image as well. Third-party images keep their configured versions. The commands below are for Dev; run them again after the upstream image builds finish to update running containers.

sudo su
cd /srv/gdi-userportal-deployment/
docker compose build --pull
docker compose run --rm -e CMD="migrate;test-data" rems
docker compose up -d

If you want to test locally with another domain, you can generated a new self-signed certificate with the following command:

openssl req -new -newkey rsa:2048 -sha256 -days 365 -nodes -x509 -keyout ./nginx/ssl/server.key -out ./nginx/ssl/server.crt -config ./nginx/ssl/openssl.cnf

Running locally

To run the whole stack on a workstation (for example to test a change before deploying it), use docker-compose.local.yml on top of docker-compose.yml. It keeps the stack self-contained:

  • nginx listens on LOCAL_HTTP_PORT (default 8088);
  • server-to-server calls to Keycloak stay inside the network;
  • the synchronizer syncs from the local CKAN, not the live catalogue;
  • REMS never sends mail;
  • the amd64-only GDI images get long health-check start periods, because on arm64 (Apple Silicon) they run under emulation.
# The GDI images are private: log in with a GitHub token that has read:packages
docker login ghcr.io            # or: podman login ghcr.io

cp .env.secrets.example .env.secrets   # fill in every value (any random strings work locally)
git update-index --skip-worktree .env.secrets   # .env.secrets is tracked: never commit real values

docker compose -f docker-compose.yml -f docker-compose.local.yml build --pull
docker compose -f docker-compose.yml -f docker-compose.local.yml up -d postgres
docker compose -f docker-compose.yml -f docker-compose.local.yml run --rm -e CMD="migrate;test-data" rems
docker compose -f docker-compose.yml -f docker-compose.local.yml run --rm -e CMD="api-key add <REMS_API_KEY> userportal" rems
docker compose -f docker-compose.yml -f docker-compose.local.yml up -d

With Podman, podman login doesn't apply to docker-compose: pull the GDI images first with podman pull --platform linux/amd64 ghcr.io/genomicdatainfrastructure/<image>:<tag>.

Browse to http://portal.localhost:8088/. The local override serves the five sites as portal.localhost, catalogue.localhost, api.localhost, daam.localhost and id.localhost: browsers resolve *.localhost to 127.0.0.1 without /etc/hosts and never force HTTPS on it, whereas a browser that has visited the real *.gdi.lu sites may refuse plain HTTP for them. From the command line: curl -H "Host: portal.localhost" http://127.0.0.1:8088/.

Logging in doesn't work locally: Keycloak, the frontend and REMS redirect browsers to the https:// hostnames in .env. CKAN starts with no datasets.

Post configuration

  • Add a new user to CKAN realm and REMS realm in Keycloak
  • Ensure both CKAN and frontend are pointing to the same Keycloak;

Contributing

We welcome contributions! If you would like to contribute, please follow these steps:

Fork the repository Create a new branch for your changes Make your changes Run the tests to ensure they pass Submit a pull request

License

This work is licensed under multiple licences. Here is a brief summary as of January 2024:

  • All original source code is licensed under Apache-2.0.
  • All documentation is licensed under CC-BY-4.0.
  • For more accurate information, check the individual files.

Java4Shell mitigation (ART-31067)

Compose disables HotSpot Base64 intrinsics using JAVA_TOOL_OPTIONS for Keycloak, Solr, and REMS, including existing published images. The Azure Keycloak and Solr examples receive the same setting. Existing caller-supplied JAVA_TOOL_OPTIONS are retained and the mitigation is appended. Custom Compose overrides must retain it.

This also covers deployments still using keycloak-ga4gh-visa-issuer:1.0.5, gdi-userportal-solr:1.14.4, or cscfi/rems:v2.39 when this Compose setting is applied. The tags currently on main differ; this change does not upgrade application versions. Recreate all three containers after applying the configuration.

For each service (keycloak, solr, rems), check the effective JVM default:

docker compose exec -T SERVICE java -XX:+PrintFlagsFinal -version 2>&1 | grep UseBASE64Intrinsics

Expect false. This launches a diagnostic JVM; it does not prove an already-running JVM inherited the flag. Confirm container recreation and inspect the running Java PID with jcmd PID VM.flags -all where the image includes jcmd; verify the flag is false. Record the image digest and java -version, and run authentication, search, and REMS application smoke tests after rollout. No live rollout is performed by this change.

This is the vendor-recommended temporary mitigation for CVE-2026-114938, not a patched JDK release. Keep it until the bundled runtime has a vendor-confirmed fix and startup checks and application smoke tests pass. If overriding JAVA_TOOL_OPTIONS, retain -XX:-UseBASE64Intrinsics alongside any existing options.

Verify the guest CPU flags and running Java versions on Deep, ELIXIR-LU OpenStack, and GCore. Lack of AVX-512 VBMI prevents this known code path but does not replace runtime updates. See the Red Hat advisory.

About

This is a deployment example of GDI User Portal, assuming RHEL-based Linux distribution.

Resources

Code of conduct

Stars

1 star

Watchers

8 watching

Forks

Releases

Packages

Used by

Contributors

Languages