Configuring user access¶
User registration via sign up form¶
By exposing the REANA User Interface, the default configuration allows users to sign-up.
When accessing the UI for the first time, users will be prompted with a sign-in form and a link to the sign-up form:
After signing up, an email is sent to the user's email address for
confirmation. Once the email address is confirmed, the user can then ask
administrators for an access token. Note that for users to be able to
receive the confirmation email, the
Helm value must be set to
true, and a working email configuration must be present.
If you would like to disable the email verification step, for example because you
disabled the REANA notifications, you can add
REANA_USER_EMAIL_CONFIRMATION: false Helm value to
User registration via Single Sign-On¶
User access through Single-Sign-On (SSO) authentication is also possible. REANA currently supports CERN SSO as well as any third-party Keycloak instance.
Keycloak Single Sign-On configuration¶
First of all, to integrate REANA with your Keycloak instance, you need to create a new client from the Keycloak's admin dashboard. There are many configuration options; the following are the minimal ones that you should set:
- Valid Redirect URIs should be set to
https://reana.example.org/api/oauth/authorized/keycloak/(see Keycloak's Access Settings);
- Client authentication should be enabled in order to get the client ID and the client secret (see Keycloak's Confidential client credentials).
You can then configure REANA to use your Keycloak instance with the following configuration of the
login list in your Helm values:
namecan be chosen freely and will be used as an internal identifier of the Keycloak instance;
typemust be set to
config.titleis the name of the Keycloak instance that will be shown to users on the web interface login page;
config.userinfo_urlshould all be set to the corresponding Keycloak endpoints.
Please note that currently only one instance of
keycloak type is supported, so the
login array in your
values.yaml file must contain at most one element:
- name: "yourprovider"
title: "YOUR PROVIDER"
You should then take the values of the client ID and the client secret that you obtained when you created your SSO application in the Keycloak dashboard and add it under the
secrets.login Helm value:
Note that the key
yourprovider must match the internal identifier name you have chosen above as the name of your Keycloak instance.
Furthermore, given that email verification is already handled by Keycloak, you have to set
Finally, to disable signup/signin for local users, you can set
When accessing the web interface, this is what the login page will look like:
For further information on how to use Keycloak, see Keycloak’s documentation.
CERN Single Sign-On configuration¶
Single Sign-On is available for CERN deployments via
Helm value. This configuration can be combined with local users or used
exclusively. When accessing the UI you will see a page like this:
When clicking on "Sign in with SSO" the users will be redirected to the corresponding login page to enter their SSO provider credentials. Once authenticated, they will be redirected back to REANA with their user logged in.
You might also want to disable the local users functionality altogether
to rely only on SSO users. To do this, set
Helm value to