generalcanvaslms

Configure SMTP for outbound emails

NOTE: We are in the process of modifying the file structure and configuration for many Bitnami stacks. On account of these changes, the file paths stated in this guide may change depending on whether your Bitnami stack uses native Linux system packages (Approach A), or if it is a self-contained installation (Approach B). To identify your Bitnami installation type and what approach to follow, run the command below:

 $ test ! -f "/opt/bitnami/common/bin/openssl" && echo "Approach A: Using system packages." || echo "Approach B: Self-contained installation."

The output of the command indicates which approach (A or B) is used by the installation, and will allow you to identify the paths, configuration and commands to use in this guide. Refer to the FAQ for more information on these changes.

To configure outbound email, follow these steps:

  • Log in to the server console.

  • Edit the outgoing_mail.yml configuration file and update it with details for your SMTP server. For example, to configure a Gmail account, you could use the settings below. Replace USERNAME, PASSWORD and DOMAIN with your Gmail account username, Gmail account password and the domain name, respectively.

    NOTE: Depending on your installation type, the outgoing_mail.yml configuration file will be located in the following paths:

    • Approach A (Bitnami installations using system packages): /opt/bitnami/canvaslms/config/outgoing_mail.yml

    • Approach B (Self-contained Bitnami installations): /opt/bitnami/apps/htdocs/config/outgoing_mail.yml

      production:
        address: "smtp.gmail.com"
        port: "587"
        enable_starttls_auto: true
        user_name: "USERNAME@gmail.com"
        password: "PASSWORD"
        authentication: "plain" # plain, login, or cram_md5
        domain: "DOMAIN"
        outgoing_address: "USERNAME@gmail.com"
        default_name: "Instructure Canvas"
    
  • Save your changes.

  • Restart the servers.

      $ sudo /opt/bitnami/ctlscript.sh restart
    

To configure the application to use other third-party SMTP services for outgoing email, such as SendGrid, refer to the FAQ.

NOTE: If you are using Gmail as the outbound email server, your application’s attempts to send outgoing emails may be blocked by Gmail if it considers the authentication attempts to be suspicious. When this happens, you will receive a Gmail security alert at the corresponding Gmail address. To proceed, you will need to manually confirm the validity of the authentication attempt before Gmail will permit the application to send outbound emails. For more information on this and other Gmail issues related to outbound email from your application, refer to our Gmail SMTP troubleshooting page.

Last modification October 19, 2021