Enabling users to access the web client from platform-generated emails

Some services in IBM® Software Hub generate notifications. For example, collaborators in a project get a notification when assets or new collaborators are added to the project. If you configure a connection to your SMTP server, users can receive these notifications through email. To ensure that these emails include active links to the web client, you must add the URL_PREFIX for your deployment to the IBM Software Hub product-configmap.

About this task

A Red Hat® OpenShift® project (namespace) administrator can edit the IBM Software Hub product-configmap to specify the URL_PREFIX for your deployment.

The URL_PREFIX is the domain name at the beginning of your deployment URL. For example, if your deployment of IBM Software Hub is accessible from https://domain.my.company.com/zen, your domain name is domain.my.company.com. Do not include the protocol in the value that you specify.

If you use the default port, 443, you do not need to specify the port number in the value for the URL_PREFIX parameter. However, if you use a non-standard port, include it in the URL_PREFIX. For example, if you use port 31843, your entry would be:
URL_PREFIX: domain.my.company.com:31843

Procedure

To enable users to access the web client from platform-generated emails:

  1. Log in to your Red Hat OpenShift cluster as an instance administrator:
    oc login OpenShift_URL:port
  2. Change to the project where you installed IBM Software Hub:
    oc project Project
  3. Run the following command to edit the IBM Software Hub product-configmap:
    oc edit cm product-configmap
  4. Add an entry for the URL_PREFIX parameter to the data section of the product-configmap file. For example:
    data:
      ...
      SHOW_USER_APPROVAL: "false"
      URL_PREFIX: domain.my.company.com
      ...
  5. Save your changes to the product-configmap file.
    For example, if you are using vi, hit esc and enter:
    :wq
    The changes are automatically applied to the platform.