Skip to content
This documentation is a preview of the pull request #2253

For the latest updates and improvements in production, open docs.codacy.com instead.

SMTP server#

Follow the instructions below to set up Codacy Self-hosted to send emails using your SMTP server:

  1. Edit the file values-production.yaml that you used to install Codacy.

  2. Set global.email.enabled: "true" and define the remaining values with the credentials for your SMTP server:

    email:
  enabled: "true"
  replyTo: "notifications@mycompany.com" # Reply-to field on sent emails
  smtp:
    protocol: "smtp" # SMTP protocol to use, either smtps or smtp
    hostname: "smtp.example.com" # Hostname of your SMTP server
    # username: "" # Optional username to authenticate on your SMTP server
    # password: "" # Optional password to authenticate on your SMTP server
    # port: 25 # Optional port of your SMTP server, the default is 25

  3. Apply the new configuration by performing a Helm upgrade. To do so execute the command used to install Codacy:

    Important

    If you're using MicroK8s you must use the file values-microk8s.yaml together with the file values-production.yaml.

    To do this, uncomment the last line before running the helm upgrade command below.

    helm upgrade (...options used to install Codacy...) \
             --version 14.0.0 \
             --values values-production.yaml \
             # --values values-microk8s.yaml

After this is done you will be able to:

  • Invite new users via email
  • Receive commit and pull request email notifications

Share your feedback 📢

Did this page help you?

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

We're sorry to hear that. Please let us know what we can improve:

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

Edit this page on GitHub if you notice something wrong or missing.

If you have a question or need help please contact support@codacy.com.

Last modified May 25, 2023