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.
Custom SMTP account or Gmail
Follow these steps:
Log in to the server console.
Navigate to the Open edX configuration directory. Depending on your installation type, it will be located in the following paths:
- Approach A (Bitnami installations using system packages): /opt/bitnami/edx/etc directory.
- Approach B (Self-contained Bitnami installations): /opt/bitnami/apps/edx/conf directory.
Depending on your installation type, modify the following lines in the LMS and Studio CMS configuration files. For example, for a Gmail account, use the settings below. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.
NOTE: Depending on your installation type, the LMS and Studio CMS configuration files will be located in the following paths, respectively:
Approach A (Bitnami installations using system packages): /opt/bitnami/edx/etc/lms.yml and /opt/bitnami/edx/etc/studio.yml.
Approach B (Self-contained Bitnami installations): /opt/bitnami/apps/edx/conf/lms.yml and /opt/bitnami/apps/edx/conf/cms.yml.
EMAIL_HOST: smtp.gmail.com, EMAIL_HOST_PASSWORD: PASSWORD, EMAIL_HOST_USER: USERNAME@gmail.com, EMAIL_PORT: 587, EMAIL_USE_TLS: true, ... DEFAULT_FROM_EMAIL: USERNAME@gmail.com,
Restart services to load the changes:
$ 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.