Skip to main content

Configure the email system

In order to receive alerts from your GitGuardian instance, you need to setup an email sending system.

You can either pick a classic SMTP configuration or use SendGrid.

  1. Go to the Admin area of ​​your GitGuardian instance. You must be an admin to access it. Admin area CTA
  2. Navigate to Settings > Email > Configuration

SMTP Configuration

You need to fill in the following information:

  • Server Host
  • Server Port
  • Username
  • Password
  • SSL activation

Email configuration SMTP

SendGrid

A SendGrid API key in necessary to send emails with SendGrid. You need to generate one from the SendGrid Website.

Email configuration Sendgrid

Checking your configuration

Once you have picked a method and saved your configuration, you can test it by pressing the Send test email button.

Shortly after that, you will receive an email on the address you used to set up your GitGuardian instance. If you did not receive any mail, check the app logs for any errors and reach out to us.