Skip to content

Commit

Permalink
Update email plugin docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@bernardjkim
bernardjkim committed Nov 20, 2024
1 parent b9ec350 commit 1e0233d
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 0 deletions.
Binary file added docs/img/enterprise/plugins/email/configure-mailgun.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/enterprise/plugins/email/enroll-email.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/enterprise/plugins/enroll.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions ...ages/admin-guides/access-controls/access-request-plugins/ssh-approval-email.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,28 @@ letting you implement security best practices without compromising productivity.

![The email Access Request plugin](../../../../img/enterprise/plugins/email.png)

<Details title="This integration is hosted on Teleport Enterprise (Cloud)" open={false}>

(!docs/pages/includes/plugins/enroll.mdx name="the Email integration"!)

![Enroll email plugin](../../../../img/enterprise/plugins/email/enroll-email.png)

To configure and connect email integration provide the following values:
`Sender`: Configures the sender address.
`Fallback Recipient`: Configures the default recipient for Access Request
notifications.
`Email Service`: Selects the desired email service. Currently, only `Mailgun` is
supported for Teleport Enterprise (Cloud).

![Configure Mailgun integration](../../../../img/enterprise/plugins/email/configure-mailgun.png)

Complete Mailgun integration by providing the follow Mailgun API configuration
values:
`Domain`: Configures the desired Mailgun sending domain.
`Mailgun Private Key`: Configures the Mailgun API key.

</Details>

Check failure on line 35 in docs/pages/admin-guides/access-controls/access-request-plugins/ssh-approval-email.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[structure.architecture-h2] In a how-to guide, the first H2-level section must be called `## How it works`. Use this section to include 1-3 paragraphs that describe the high-level architecture of the setup shown in the guide, i.e., which infrastructure components are involved and how they communicate. If there is already architectural information in the guide, include it in a `## How it works` section.

Raw Output:
{"message": "[structure.architecture-h2] In a how-to guide, the first H2-level section must be called `## How it works`. Use this section to include 1-3 paragraphs that describe the high-level architecture of the setup shown in the guide, i.e., which infrastructure components are involved and how they communicate. If there is already architectural information in the guide, include it in a `## How it works` section.", "location": {"path": "docs/pages/admin-guides/access-controls/access-request-plugins/ssh-approval-email.mdx", "range": {"start": {"line": 35, "column": 1}}}, "severity": "ERROR"}
## Prerequisites

(!docs/pages/includes/commercial-prereqs-tabs.mdx!)
Expand Down

0 comments on commit 1e0233d

Please sign in to comment.