Use a Custom Start Application#

ESS includes a default start application that allows users to sign up or login with the Identity Provider. You can replace the default start application with a custom start application. ESS’ WebID service and ESS’ Pod provision service provide various endpoints that can be used by start applications to create a WebID and a Pod for a user.

To use a custom start application, update the following configuration with your application’s Solid-OIDC Client ID (e.g., https://myStart.example.com/appid/id):

QUARKUS_OIDC_CLIENT_ID configuration for the Start service and
INRUPT_START_CLIENT_ID and INRUPT_WEBID_ALLOWED_CLIENT_IDS configuration for the WebID service.

Example Customization#

The following example assumes a custom start application with the Solid-OIDC Client ID value https://myStart.example.com/appid/id. To use this application, instead of the default start app, update the following configuration options:

For the Start service:
- QUARKUS_OIDC_CLIENT_ID.
For the WebID service:
- INRUPT_START_CLIENT_ID
- INRUPT_WEBID_ALLOWED_CLIENT_IDS.

Go to your ESS installation directory:
```
cd ${HOME}/ess
```

Create a start-app.yaml file with the following content:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: ess-start
spec:
  template:
    spec:
      containers:
      - env:
        - name: QUARKUS_OIDC_CLIENT_ID
          value: https://mystart.example.com/appid/id
        name: ess-start

Create a webid-service-start-app-conf.yaml file with the following content:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: ess-webid
spec:
  template:
    spec:
      containers:
      - env:
        - name: INRUPT_START_CLIENT_ID
          value: https://mystart.example.com/appid/id
        - name: INRUPT_WEBID_ALLOWED_CLIENT_IDS
          value: $(INRUPT_WEBID_CLIENT_ID),$(INRUPT_START_CLIENT_ID)
        name: ess-webid

Modify the kustomization.yaml (i.e., step 3 of the Applying Your Customizations procedure) to use start-app.yaml and webid-service-start-app-conf.yaml.

Specifically, add the highlighted content to the kustomization.yaml file to the patches section:

Tip

If the patches key does not exist in kustomization.yaml, add the patches key as well.
```
# kustomization.yaml in your ESS installation directory

# ...  Preceding content omitted for brevity 
# ...

patches:
  - path: start-app.yaml
  - path: webid-service-start-app-conf.yaml
```
Continue with the rest of the Applying Your Customizations procedure.