Configure SMTP for outbound emails

Before running the commands shown on this page, you should load the Bitnami stack environment by executing the installdir/use_APPNAME script (Linux and MacOS) or by clicking the shortcut in the Start Menu under “Start -> Bitnami APPNAME Stack -> Application console” (Windows). On OS X VMs, the installation directory is /opt/bitnami and OS X VM users can click the “Open Terminal” button to run commands. Learn more about the Bitnami stack environment and about OS X VMs.

Configure the email settings in the installdir/apps/openproject/htdocs/config/configuration.yml file.

A sample configuration for a Gmail account is shown below. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.

  email_delivery_method: "smtp"
  smtp_enable_starttls_auto: true
  smtp_address: ""
  smtp_port: 587
  smtp_domain: ""
  smtp_authentication: :plain
  smtp_openssl_verify_mode: "none"
  smtp_password: PASSWORD

Once the configuration.yml file is changed, you need to restart Apache.

$ sudo installdir/ restart apache

To receive all notifications, set an extra configuration value in the administration panel. Click the “Administration -> My account -> Email notifications” menu item and set “For any event on all my projects”.

To change the OpenProject URL value of the sent emails, navigate to “Administration -> Settings -> General” and change the “Host name” value.

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 November 17, 2020