OpenConext-Access

Getting started

System Requirements

• Java 21
• Maven 3

First install Java 21 with a package manager and then export the correct the JAVA_HOME. For example, on macOS:

export JAVA_HOME=/Library/Java/JavaVirtualMachines/openjdk-21.jdk/Contents/Home/

Then create the MySQL database:

DROP DATABASE IF EXISTS access;
CREATE DATABASE access CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci;
CREATE USER 'access'@'localhost' IDENTIFIED BY 'secret';
GRANT ALL privileges ON `access`.* TO 'access'@'localhost';

Building and running

The access server uses Spring Boot and Maven. To run locally, type:

cd server
mvn spring-boot:run

The access client uses ReactJS. To run locally, type:

cd client
nvm use
yarn dev

Mail

In the default application.properties the mail host is localhost and the port is 1025. Run mailpit to capture mails. See https://github.com/axllent/mailpit

Local endpoints

Login with Mujina IdP and user admin to become superuser in the local environment.

To become an institution admin in access, add the following values as eduPersonEntitlements using Mujina:

• urn:mace:surfnet.nl:surfnet.nl:sab:organizationGUID:ad93daef-0911-e511-80d0-005056956c1a
• urn:mace:surfnet.nl:surfnet.nl:sab:role:SURFconextverantwoordelijke

Add attribute

If the GUI for maintaining a connection, needs an additional attribute, then the following source files need to be altered:

• access.manage.ConnectionProviderConverter#convert
• access.model.Connection#mergeMetaData
• utils/Connection.js#convertClientConnectionToServer

Upgrade

To update the pom.xml with the latest versions, run

cd server
mvn versions:use-latest-releases

To see the latest versions report for the client run

cd client
nvm use
yarn outdated

Designs

https://www.figma.com/design/81StIVqfOKfwhWVjx7Ew81/SURF-Access?node-id=1916-18441&t=gmckiSapuONmLn5u-4