Customization of self service emails

4.2. Customization of self service emails#

This section describes which self service emails you can customize and how to do it. You need the Helm Chart for Nubus, your customized deployment file custom_values.yaml, and the files for customization described in this section.

You can customize the self service emails for the password reset.

4.2.1. Configure password reset#

To configure a custom password reset email body, add the configuration value nubusUmcServer.selfService.passwordresetEmailBody to your custom_values.yaml deployment file and configure the text, as you like. You can use the following placeholders in curly brackets to customize the message for the user that requests a password reset:

username:

The username of the user that wishes to reset their password.

token:

The token for the password reset.

link:

Link to the Password Reset website.

tokenlink:

Link to the Password Reset website with the username and token already entered.

Listing 4.4 shows an example. To apply the changes, see the steps in Apply configuration changes.

Listing 4.4 Example for customizing the password reset email body#
nubusUmcServer:
  selfService:
    passwordresetEmailBody: |
      Dear user {username},

      we have received a password reset request for your account. If you did not
      wish to change your password, you can safely ignore this message.

      To change your password please follow this link:

      {tokenlink}

      If the link does not work, you can go to

      {link}

      and enter the following token manually:

      {token}

      Greetings from your password self service system.

4.2.2. Apply configuration changes#

To apply the updated configuration in your custom_values.yaml deployment file to Nubus, run the commands in Listing 4.5. Kubernetes automatically updates the ConfigMap and restarts the affected Kubernetes pods to apply the changes.

Listing 4.5 Apply customization to Nubus#
$ export NAMESPACE_FOR_NUBUS="Set to your Kubernetes namespace"
$ export RELEASE_NAME="The Helm Chart release name"
$ export VERSION="Your version of Nubus"
$ helm upgrade \
   "$RELEASE_NAME" \
   --namespace="$NAMESPACE_FOR_NUBUS" \
   oci://artifacts.software-univention.de/nubus/charts/nubus \
   --values custom_values.yaml \
   --version "$VERSION"