Skip to content

Configuring connection with a VIP instance

Jump to bottom
Youenn edited this page Nov 30, 2023 · 17 revisions

Prerequisite

  • VIP must have been configured to allow interactions with Shanoir API and Keycloak server
    • Shanoir API public URL is needed for downloading input and uploading output
    • Shanoir keycloak server public URL is needed to authenticate end- and technical users
  • The Shanoir end-user that will launch execution on VIP must have an account with the same email address on VIP
  • The service-account technical client must have an account with the same email address on VIP (see $VIP_CLIENT_EMAIL below)

Shanoir configuration

The following environment variables must be set to configure the connection to VIP API by Shanoir frontend and backend.

When starting Shanoir through docker-compose on your local machine, these variables can be set in the .env file.

See docker-compose documentation for more options.

$VIP_URL_HOST

This environment variable must be set for nginx and datasets containers.

Value must be the hostname (or IP address) of the public VIP domain (e.g. vip.creatis.insa-lyon.fr).

$VIP_URL_SCHEME

This environment variable must be set for nginx and datasets containers.

Value must be the VIP URL scheme, i.e. https or http.

$VIP_CLIENT_EMAIL

This environment variable must be set for users container.

Value must be the email address under which the service-account technical user is registered in VIP (e.g. [email protected]). This does not necessarily have to be a real one.

Additional documentation

VIP API

https://app.swaggerhub.com/apis/CARMIN/carmin-common_api_for_research_medical_imaging_network/0.3.1

Boutiques task description format

https://github.com/boutiques/boutiques/tree/master/boutiques/schema

Clone this wiki locally