Configuring connection with a VIP instance - fli-iam/shanoir-ng GitHub Wiki

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
    • shanoir-ng-front must be configured as realm on VIP keycloak
    • Cross-origin resource sharing (CORS) must be allowed on VIP side, for interactions with Shanoir front
  • 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), as well as a role named "ROLE_SERVICE"

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. It is used to set up VIP API address in Shanoir frontend and backend.

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. It is used to set up VIP API address in Shanoir frontend and backend.

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

$VIP_CLIENT_EMAIL

This environment variable must be set for users container. It is used to authenticate Shanoir backend on VIP API, in order to monitor execution(s) status.

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