Start Service

New in version 2.0.

ESS provides a service that acts as the starting point for the ESS user interface.

Start Service Endpoint

ESS Start Service hosts an application that runs at:

https://start.{ESS Domain}

ESS Start Application

The ESS’ start application allows a user to sign up or login with the Identity Provider. You can replace the default start application with a custom start application.

Create a WebID

Start applications can call ESS’ WebID service to create a WebID and manage the WebID profile document. The application can derive the WebID service’s endpoints by concatenating:

• the WebID Service’s base URL and

• the username portion of the webid claim (from the ID token).

Create a Pod for WebID

Start applications can call ESS’ Pod provision service to provision the Pod for the user.

Add Pod Location to WebID Profile

Once provisioned, start applications can call the ESS’ WebID service to update the WebID profile document with the Pod location.

Start Application Configuration

To use with the various ESS services, the following configuration options must be set to the start application’s Solid-OIDC Client ID:

• QUARKUS_OIDC_CLIENT_ID configuration for the ESS Start service and

• INRUPT_START_CLIENT_ID and INRUPT_WEBID_ALLOWED_CLIENT_IDS configuration for the ESS WebID service.

For example, the default ESS start application has https://start.{ESS DOMAIN}/app/id as its Client ID, and the provided overlays use this value in the configuration.

If using a custom start application, update the configuration to the the custom start application’s Client ID.

See Use a Custom Start Application.

Configuration

As part of the installation process, Inrupt provides base Kustomize overlays and associated files that require deployment-specific configuration inputs.

The following configuration options are available for the service and may be set as part of updating the inputs for your deployment. The Inrupt-provided base Kustomize overlays may be using updated configuration values that differ from the default values.

INRUPT_PROVISION_HTTP_BASE_URL

The base URL of the Pod Provisioning Service.

Important

The value requires a trailing slash /; e.g., https://provision.{ESS_DOMAIN}/.

The ESS’ Start application uses this value to determine the ESS’ Pod provisioning endpoint.

INRUPT_WEBID_HTTP_BASE_URL

The base URL of the WebID Service.

Important

The value requires a trailing slash /; e.g., https://id.{ESS DOMAIN}/.

The ESS’ Start application uses this value to determine the base URL of the ESS’ WebID service endpoints.

QUARKUS_LOG_LEVEL

Default: INFO

Logging level.

QUARKUS_OIDC_AUTH_SERVER_URL

The URL of the Solid OIDC Broker Service.

QUARKUS_OIDC_CLIENT_ID

Default: https://start.{ESS DOMAIN}/app/id

The Solid-OIDC Client ID (i.e., the URL that dereferences to a Client ID document) of the start app for signing in/up with the Identity Provider.

See also:

• INRUPT_START_CLIENT_ID

• INRUPT_WEBID_ALLOWED_CLIENT_IDS

Important

Please ensure that the INRUPT_WEBID_ALLOWED_CLIENT_IDS includes the value used for the Start service Client ID, defined in INRUPT_START_CLIENT_ID.

Kafka Configuration

Tip

See also ESS’ Kafka Configuration.

INRUPT_KAFKA_AUDITV1EVENTSENCRYPTED_CIPHER_PASSWORD

The strong cipher key to use when running auditing with encrypted messages.

Additional Information

See also https://quarkus.io/guides/all-config.