Start Service

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:

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.

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.

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:

Configuration Logging

ESS services log their startup configuration.

Note Whitespaces are preserved when parsing comma-delimited lists (i.e., the parsed string values are not trimmed). For example, when parsed, "value1, value2,value3 " results in "value1" , " value2" , "value3 " .

INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW

Default : inrupt,quarkus.oidc.auth-server-url

A comma-separated list of configuration property prefixes ( case-sensitive ) that determine which configurations are logged:

When specifying the prefixes, you can specify the prefixes using one of two formats:

Tip To avoid allowing more than desired configurations, specify as much of the prefix as possible. If the prefix specifies the complete prefix term, include the term delineator. For example:

  • If using dot-notation, if you want to match configuration properties of the form foobar.<xxxx>... , specify foobar. (including the dot . ) instead of, for example, foo or foobar .

  • If using converted form, if you want to match configuration properties of the form FOOBAR_<XXXX>... , specify FOOBAR_ (including the underscore _ ) instead of, for example, FOO or FOOBAR .

INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY

A comma-separated list of configuration name prefixes (case-sensitive) that determines which configurations (that would otherwise match the INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW ) are not logged. That is, INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY acts as a filter on INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW . For example:

  • If foobar. is an allowed prefix, to suppress foobar.private.<anything> , you can specify foobar.private. to the deny list.

  • If foobar. is not an allowed prefix, no property starting with foobar. is logged. As such, you do not need to specify foobar.private to the deny list.

When specifying the prefixes, you can specify the prefixes using one of two formats:

Logging Redaction

INRUPT_LOGGING_REDACTION_NAME_ACTION

Default : REPLACE

Type of the redaction to perform. Supported values are:

Action
Description

REPLACE

Default. Replaces the matching text with a specified replacement.

PLAIN

Leaves the matching field unprocessed. Only available if the redaction target is a field (i.e., INRUPT_LOGGING_REDACTION_{NAME}_FIELD).

DROP

Suppresses the matching field. Only available if the redaction target is a field (i.e., INRUPT_LOGGING_REDACTION_{NAME}_FIELD).

PRIORITIZE

Changes the log level of the matching message.

SHA256

Replaces the matching text with its hash.

  • If the action is REPLACE ( default ), see also INRUPT_LOGGING_REDACTION_{NAME}_REPLACEMENT .

  • If the action is to PRIORITIZE , see also INRUPT_LOGGING_REDACTION_{NAME}_LEVEL .

For more information on log redaction, see Logging Redaction.

INRUPT_LOGGING_REDACTION_NAME_ENABLED

Default : true

A boolean that determines whether the redaction configurations with the specified INRUPT_LOGGING_REDACTION_{NAME}_ prefix is enabled.

For more information on log redaction, see Logging Redaction.

INRUPT_LOGGING_REDACTION_NAME_EXCEPTION

Fully qualified name of the exception class to match in the log messages (includes inner exception). Configure to target an exception message class.

For more information on log redaction, see Logging Redaction.

INRUPT_LOGGING_REDACTION_NAME_FIELD

Exact name of the field to match in the log messages. Configure to target a specific log message field for redaction.

For more information on log redaction, see Logging Redaction.

INRUPT_LOGGING_REDACTION_NAME_LEVEL

A new log level to use for the log message if the INRUPT_LOGGING_REDACTION_{NAME}_ACTION is PRIORITIZE .

INRUPT_LOGGING_REDACTION_NAME_PATTERN

A regex (see Java regex pattern) to match in the log messages. Configure to target log message text that matches a specified pattern.

For more information on log redaction, see Logging Redaction.

INRUPT_LOGGING_REDACTION_NAME_REPLACEMENT

Replacement text to use if the INRUPT_LOGGING_REDACTION_{NAME}_ACTION is REPLACE .

If unspecified, defaults to [REDACTED] .

For more information on log redaction, see Logging Redaction.

Application-Defined Metadata Propagation

INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW

A comma-separated list of application-defined properties that can be included in the associated audit events (unless specified in the corresponding INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY) .

This configuration is case-sensitive to the propagated properties in the baggage.

Tip To include a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY

A comma-separated list of application-defined properties to exclude from the associated audit messages. This setting takes precedence over INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW.

This configuration is case-sensitive to the propagated properties in the baggage.

Tip To exclude a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

INRUPT_LOGGING_REQUEST_METADATA_ALLOW

A comma-separated list of application-defined properties that can be included in the associated log messages (unless specified in the corresponding INRUPT_LOGGING_REQUEST_METADATA_DENY) .

This configuration is case-sensitive to the propagated properties in the baggage.

Tip To include a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

INRUPT_LOGGING_REQUEST_METADATA_DENY

A comma-separated list of application-defined properties to exclude from the associated log messages. This setting takes precedence over INRUPT_LOGGING_REQUEST_METADATA_ALLOW.

This configuration is case-sensitive to the propagated properties in the baggage.

Tip To exclude a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW

A comma-separated list of non-baggage request headers to add to the baggage (unless specified in the corresponding INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY) ; i.e., include these non-baggage request headers as application-defined properties.

The configuration is case-insensitive; i.e., the listed headers do not need to match the case of the client request headers. For example, a list that includes x-correlation-id can match x-correlation-id header, X-CoRrElAtIoN-Id header, etc.

See:

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY

A comma-separated list of non-baggage request headers to exclude from being added to the baggage ; i.e., excludes these headers as application-defined properties. This setting takes precedence over INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW.

The configuration is case-insensitive; i.e., the listed headers do not need to match the case of the client request headers. For example, a list that includes x-correlation-id can match (and exclude) x-correlation-id header, X-CoRrElAtIoN-Id header, etc.

See:

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_OVERRIDES

A flag that determines ESS behavior when metadata property is defined both as a header and as a baggage entry:

  • If true ESS updates/overrides the baggage entry with the header value.

  • If false (the default), ESS keeps the baggage entry.

For details, Duplicate Property Definition.

INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW

A comma-separated list of application-defined properties that can return as response headers (unless specified in the corresponding INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY) .

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

See:

INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY

A comma-separated list of application-defined properties to exclude from returning as response headers. This setting takes precedence over INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW.

This configuration is case-sensitive to the propagated properties in the baggage.

Tip To exclude a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

Additional Information

See also Quarkus Configuration Options

Last updated