Customize Approval Page#

To use a customized approval page, set the INRUPT_OPENID_APPROVAL_TEMPLATE_LOCATION property of the ESS’ OpenID Provider.

Example Customization#

In the following, the example customization file specifies the path of the new approval page.

  1. Go to your ESS installation directory:

    cd ${HOME}/ess
    
  2. Add your new approval page file. In this example, the new file is named approval.html

  3. Create a custom-approval-env.yaml file:

    #custom-approval-env.yaml
    
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: ess-openid
    spec:
      template:
        spec:
          containers:
            - name: ess-openid
              env:
                - name: INRUPT_OPENID_APPROVAL_TEMPLATE_LOCATION
                  value: approval.html
    

    The INRUPT_OPENID_APPROVAL_TEMPLATE_LOCATION specifies the location to the new approval page.

  4. Modify the kustomization.yaml (i.e., step 3 of the Applying Your Customizations procedure).

    Specifically, add the highlighted content to the kustomization.yaml file under the patchesStrategicMerge key:

    Tip

    If patchesStrategicMerge key does not exist in kustomization.yaml, add the key patchesStrategicMerge as well.

    # kustomization.yaml in your ESS installation directory
    
    # ...  Preceding content omitted for brevity 
    # ...
    
    patchesStrategicMerge:
      - custom-approval-env.yaml
    
  5. Continue with the rest of the Applying Your Customizations procedure.

For additional configuration properties for the ESS’ OpenID Provider, see OpenID Provider.