Setting the hostname for links in generated emails

Edge automatically sends emails in response to certain events as described in Customizing Edge email templates.

Many of these emails contain a link. For example, when a user is added to an organization, the New Edge UI sends the user an email containing a console or account activation URL in the form:

https://domain/edge
https://domain/createpassword/token

The domain is determined automatically by the New Edge UI and is typically correct for the organization. However, when the New Edge UI is behind a load balancer, the automatically generated domain name might not match the external load balancer hostname. If so, you can use the conf_apigee_apigee.emails.hosturl property to explicitly set the base URL of the generated links.

To set the hostname:

  1. Open the management-ui.properties file in an editor. If the file does not exist, create it:
    vi /opt/apigee/customer/application/management-ui.properties
  2. Set conf_apigee_apigee.emails.hosturl. For example:
    conf_apigee_apigee.emails.hosturl="http://myCo.com"
  3. Save your changes.
  4. Make sure the properties file is owned by the apigee user:
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  5. Restart the New Edge UI:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart