Notification Gateway Service

Added in version 1.1.

ESS provides a Notification Gateway service for discovering the protocol-specific endpoints. [1]

Notification Gateway Service Endpoint

ESS Notification Gateway Service has the following endpoint:

https://notification.<ESS Domain>/

To determine the WebSocket Notification Service endpoint, clients can POST to the ESS Notification Gateway; no authentication is required:

Method:	POST
Endpoint:	https://notification.<ESS Domain>/
Content-Type:	application/json
Body:	{ "protocols": ["ws"] }

The response JSON contains the WebSocket endpoint that clients can access for login; for example:

{ "endpoint": "https://websocket.<ESS Domain>/", "features": [], "protocol": "ws" }

See WebSocket Notification Service for details on using the endpoint.

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.

Required

INRUPT_NOTIFICATION_PROTOCOLS_WS_ENDPOINT

The URL of the WebSocket endpoint (e.g., https://websocket.{ESS Domain}/) returned by the Gateway.

Added in version 2.1.

INRUPT_NOTIFICATION_WS_ENDPOINT

The URL of the WebSocket endpoint (e.g., https://websocket.{ESS Domain}/) returned by the Gateway.

Additional Information

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

[1]

Notification Gateway Service is based on an early draft version of Solid Notifications Protocol. Features based on the draft specifications are subject to change.