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.
Email settings can be configured in the Redmine configuration.yml configuration file.
NOTE: Depending on your installation type, the Redmine configuration.yml configuration file can be found in the following locations:
Approach A (Bitnami installations using system packages): /opt/bitnami/redmine/config/configuration.yml
Approach B (Self-contained Bitnami installations): /opt/bitnami/apps/redmine/htdocs/config/configuration.yml
The file includes sample configuration settings for most common scenarios, including Gmail. To use Gmail as the SMTP server, find and uncomment the Gmail settings such that you end up with the result below. Remember to update the user_name and password variables with the correct credentials for the Gmail account you plan to use.
# ==== SMTP server at using TLS (GMail) # This might require some additional configuration. See the guides at: # http://www.redmine.org/projects/redmine/wiki/EmailConfiguration # email_delivery: delivery_method: :smtp smtp_settings: enable_starttls_auto: true address: "smtp.gmail.com" port: 587 domain: "smtp.gmail.com" # 'your.domain.com' for Google Apps authentication: :plain user_name: "USERNAME@gmail.com" password: "PASSWORD"
After making this change, log in to the Redmine administration panel and navigate to the “Administration -> Settings -> Notifications” page. Update the sender address on this page to match the address defined in the Redmine configuration.yml configuration file edited previously.
Once the configuration settings have been modified, restart the services following these instructions.
To change the link that appears in the email, navigate to the “Administration -> Settings -> General -> Host name and path” section and enter your domain name and port.
Troubleshooting email configuration issues
In case you receive an error message containing “530 5.7.0 Must issue a STARTTLS command first …”, make sure you have the enable_starttls_auto property set after the password line. For example:
email_delivery: delivery_method: :smtp smtp_settings: enable_starttls_auto: true address: "smtp.gmail.com" port: 587 domain: "smtp.gmail.com" # 'your.domain.com' for GoogleApps authentication: :plain user_name: "USERNAME@gmail.com" password: "PASSWORD"
In Redmine 2.0 or greater, if you see an error similar to “An error occurred while sending mail (SSL_connect returned=1 errno=0 state=SSLv2/v3 read server hello A: unknown protocol)”, remove the tls: true option from the configuration.yml file. Then, restart the services as described in the previous section.
If using an SMTP server that does not require authentication, you may need to add the openssl_verify_mode: ‘none’ option to the configuration.yml file.
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.