Back to the admin manual

Configuration panel#

Configuration panel allows administrators to configure global parameters of a MINERVA instance. Particular categories of configuration items are grouped as listed below.

Server#

This group manages options relevant for the MINERVA Platform webserver.

Email notification details#

• E-mail address - e-mail address used for sending notifications about the activity of a MINERVA instance - project uploads, comments, sign up, etc.

• E-mail server login, E-mail server password, IMAP server, SMTP port and SMTP server - configuration of your mail server for notification sending.

• Email content used for requesting an account - the Info and Overlay tabs in the user interface allow to a Request for an account action, which will auto-compose an email with the message defined in Email content used for requesting an account to addressed to the e-mail, or e-mails (separated by a semicolon) provided in the field Email used for requesting an account.

Document links#

• URL of platform Terms of Service - path in the directory or URL to a document describing terms of service for this MINERVA instance.

• Privacy policy (url) - URL of the cookie policy.

• User manual file - location in the directory structure of a MINERVA instance for the user manual file.

Content visibility#

• Default project Id - the project that will be displayed by default under the root address of the platform (your.url/minerva/).

• Minerva root url - MINERVA instance URL (your.url/minerva/).

• Minerva net host - URL of the MINERVA-Net repository, (default: https://minerva-net.lcsb.uni.lu/).

• Authentication token in minerva-net - allows to register instance in MINERVA-Net, token is “password” and root url of instance is login, both necessary for registration.

• Domain allowed to connect via x-frame technology - the address of a website allowed to embed a MINERVA instance via x-frame technology.

User registration#

• Allow users to create accounts - if enabled, this allows users to sign up on their own.

• Require admin approval for auto-registered accounts - specifies whether a user’s account is activated immediately after signing up or requires an administrator’s review and approval.

Advanced#

• Disable CORS - when selected the response will allow for Cross-Origin Resource Sharing when authenticated (for instance when JS code on other site would like to connect to the API of this specific minerva instance). However, to make it work properly CORS request must have ‘ORIGIN’ header set properly.

• Path to store big files - location in the directory structure of a MINERVA instance to store big files.

• Max session inactivity time (in seconds) - set the time after users are logged out automatically.

• Matomo tracking URL - provide here a valid Matomo URL to track user activity of a MINERVA instance.

Interface#

This group manages how diagrams are displayed.

Legend and logo#

• Left logo description - the popup text that will be displayed upon mouse hover your left logo.

• Left logo icon - the filename of your left logo icon, displayed in the bottom-left corner of the main view; path in the directory or URL.

• Left logo link (after click) - the website to which you will be redirected after clicking on the left logo.

• Right logo description - the popup text that will be displayed upon mouse hover your right logo.

• Right logo icon - the filename of your right logo icon, displayed in the bottom-right corner of the main view; path in the directory or URL.

• Right logo link (after click) - the website to which you will be redirected after clicking on the left logo.

• Legend 1-4 image files - path in the directory structure of a MINERVA instance for displayed legend images.

• Custom CSS - path to user’s own stylesheet.

Overlays#

• Overlay color for negative/positive values - sets the colors should be used for positive and negative values in basic overlays. Values close to zero have the lowest color saturation, values close to -1/1 have the highest color saturation.

• Overlay color when no values are defined - sets the color to use for coloring list of elements overlays; see section User manual - Upload user-provided overlay data

• Overlay color for value=0

• Opacity used when drawing data overlays (value between 0.0-1.0)

Access#

This group manages options relevant for automating user authentication in the platform.

LDAP configuration#

LDAP allows to log in to MINERVA with user’s global credentials. Note that: A user can log in to MINERVA via LDAP authentication without creating account on MINERVA instance. Such users is granted by default with the privileges of the public user (anonymous). Non-default privileges can be set after their first login.

Please find below description and examples of LDAP configuration for MINERVA:

• LDAP login (user id); e.g. uid

• LDAP password - password for the LDAP bind DN

• LDAP address - address of the machine where LDAP server is located; e.g. lums2.uni.lu

• LDAP port - port on which LDAP is listening (by default it’s 389, for SSL connections usually it’s 636)

• LDAP uses SSL - check to use SSL for LDAP connection

• LDAP bind DN - Distinguished Name of the user account that should be used for LDAP connection (this user should be able to search/list accounts on LDAP server); e.g. uid=ldap-reader-minerva,cn=users,cn=accounts,dc=uni,dc=lu

• LDAP base DN - definition of the point from where a server will search for users; e.g. cn=users,cn=accounts,dc=uni,dc=lu

• LDAP filter - when there are many accounts in LDAP administrators create groups of users that have access to specific systems, this filter allows to define LDAP filter that will limit set of accounts that can access minerva, empty string disable filtering; e.g. (memberof=cn=minerva,cn=groups,cn=accounts,dc=uni,dc=lu)

• LDAP filter objectClass - this parameter allows to filter by objectClass type of LDAP entry; value * skips the filtering

• LDAP first name attribute - which attribute in LDAP directory corresponds to “First name” of the user; e.g. givenName

• LDAP last name attribute - which attribute in LDAP directory corresponds to “Last name” of the user; e.g sn

• LDAP email attribute - which attribute in LDAP directory corresponds to the user email address; e.g. mail

OAuth configuration#

This configuration item allows you to link your MINERVA Platform to ORCID system. In effect, the users will be able to log in to your MINERVA instance using their ORCID credentials.

• Orcid Client ID and Orcid Client Secret can be obtained following the procedure below.

• Create an account in ORCID: https://orcid.org/ or use an existing one

• After signing in to ORCID go to developers page: https://orcid.org/developer-tools

• Generate Client ID and Client secret

• Fill in Application details.

• Add a Redirect URI to your instance of the MINERVA Platform.

  • The Redirect URI must look like: “https://{domain_name}/minerva/login/oauth2/code/orcid” where {domain_name} is domain where the minerva instance is hosted
  • Example: if the MINERVA Platform is hosted at https://minerva-dev.lcsb.uni.lu/minerva/ then a Redirect URI will be: https://minerva-dev.lcsb.uni.lu/minerva/login/oauth2/code/orcid

• Go to your instance of the MINERVA Platform and login to admin panel.

• provide your Orcid Client ID and Orcid Client Secret in the Configuration > Access > OAuth configuration

Connectors#

This group configures programmatic connectivity of MINERVA with external services.

Register in MINERVA-Net#

To share your projects on MINERVA Net, first your MINERVA instance must be registered by providing your email and pressing Register instance.

MINERVA-Net is a registry of publicly shared disease maps projects. This registry was established to enhance the collaboration of the MINERVA Platforms users by providing possibility to share information about the projects on the central server. This information can be used to query individual instances of the MINERVA Platform using their API interfaces.

Read more and view the list of registered projects in MINERVA-Net here.

Check MINERVA-Net API Docs here.

On registration, MINERVA-Net collects:

• URL of this instance (root url, see Content visibility)
• email of the platform administrator, used only internally, to inform about potential communication errors.

Read about sharing individual projects in the documentation of the Project panel.