debian-mirror-gitlab/doc/administration/integration/mailgun.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

53 lines
2.4 KiB
Markdown
Raw Normal View History

2021-11-11 11:23:49 +05:30
---
2022-07-23 23:45:48 +05:30
stage: Plan
group: Project Management
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-11-11 11:23:49 +05:30
type: reference, howto
---
# Mailgun and GitLab **(FREE SELF)**
When you use Mailgun to send emails for your GitLab instance and [Mailgun](https://www.mailgun.com/)
integration is enabled and configured in GitLab, you can receive their webhook for
2022-07-23 23:45:48 +05:30
tracking delivery failures. To set up the integration, you must:
2021-11-11 11:23:49 +05:30
1. [Configure your Mailgun domain](#configure-your-mailgun-domain).
1. [Enable Mailgun integration](#enable-mailgun-integration).
2022-07-23 23:45:48 +05:30
After completing the integration, Mailgun `temporary_failure` and `permanent_failure` webhooks are sent to your GitLab instance.
2021-11-11 11:23:49 +05:30
## Configure your Mailgun domain
2022-08-27 11:52:29 +05:30
> - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/359113) the `/-/members/mailgun/permanent_failures` URL in GitLab 15.0.
> - [Added](https://gitlab.com/gitlab-org/gitlab/-/issues/359113) the URL to handle both temporary and permanent failures in GitLab 15.0.
2022-07-23 23:45:48 +05:30
Before you can enable Mailgun in GitLab, set up your own Mailgun endpoints to receive the webhooks.
2021-11-11 11:23:49 +05:30
2022-08-13 15:12:31 +05:30
Using the [Mailgun webhook guide](https://www.mailgun.com/blog/product/a-guide-to-using-mailguns-webhooks/):
2021-11-11 11:23:49 +05:30
1. Add a webhook with the **Event type** set to **Permanent Failure**.
2022-07-23 23:45:48 +05:30
1. Enter the URL of your instance and include the `/-/mailgun/webhooks` path.
For example:
```plaintext
https://myinstance.gitlab.com/-/mailgun/webhooks
```
1. Add another webhook with the **Event type** set to **Temporary Failure**.
1. Enter the URL of your instance and use the same `/-/mailgun/webhooks` path.
2021-11-11 11:23:49 +05:30
## Enable Mailgun integration
2022-07-23 23:45:48 +05:30
After configuring your Mailgun domain for the webhook endpoints,
2021-11-11 11:23:49 +05:30
you're ready to enable the Mailgun integration:
1. Sign in to GitLab as an [Administrator](../../user/permissions.md) user.
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu >** **{admin}** **Admin**.
2021-11-11 11:23:49 +05:30
1. On the left sidebar, go to **Settings > General** and expand the **Mailgun** section.
2022-11-25 23:54:43 +05:30
1. Select the **Enable Mailgun** checkbox.
2021-11-11 11:23:49 +05:30
1. Enter the Mailgun HTTP webhook signing key as described in
2022-08-27 11:52:29 +05:30
[the Mailgun documentation](https://documentation.mailgun.com/en/latest/user_manual.html#webhooks-1) and
2023-01-13 00:05:48 +05:30
shown in the API security (`https://app.mailgun.com/app/account/security/api_keys`) section for your Mailgun account.
2021-11-11 11:23:49 +05:30
1. Select **Save changes**.