Configuring the Edge SMTP server

Edge for Private Cloud v4.18.05

An SMTP server allows the Edge UI to send emails. For example, the Edge UI can send an email to assist a user in recovering their UI password.

At install time, you can specify the SMTP information. To change the SMTP information, or if you deferred SMTP configuration at the time of installation, you can use the apigee-setup utility to modify the SMTP configuration.

You can change any or all of the following information:

  • SMTP host, such as smtp.gmail.com
  • SMTP port, such as 465 if you are using TLS/SSL
  • SMTP username and password
  • SMTP "From" email address

To update the SMTP information:

  1. Edit the configuration file that you used to install Edge, or create a new configuration file with the following information:
    # Must include the sys admin password
    APIGEE_ADMINPW=sysAdminPW
    # SMTP settings
    SKIP_SMTP=n
    SMTPHOST=smtp.example.com
    SMTPUSER=smtp@example.com  # 0 for no username
    SMTPPASSWORD=smtppwd       # 0 for no password
    SMTPSSL=n
    SMTPPORT=25
    SMTPMAILFROM="My Company <myco@company.com>"
  2. Run the apigee-setup utility on all the Edge UI nodes to update the SMTP settings:
    /opt/apigee/apigee-setup/bin/setup.sh -p ui -f configFile

    The apigee-setup utility restarts the Edge UI.