Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update email plugin docs #49299

Merged
merged 2 commits into from
Nov 22, 2024
Merged

Update email plugin docs #49299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca5994d
Update email plugin docs
bernardjkim Nov 20, 2024
4862959
Merge branch 'master' into bernard/email-plugin-docs
bernardjkim Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/img/enterprise/plugins/email/configure-mailgun.png
View file
Open in desktop
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
Open in desktop
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
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions ...ages/admin-guides/access-controls/access-request-plugins/ssh-approval-email.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,34 @@

![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)

Configure and connect email integration by providing the following configuration
values:

**`Sender`**: Configures the sender address.

**`Fallback Recipient`**: Configures the default recipient for Access Request
notifications.

**`Email Service`**: Selects the desired email service. Note: only `Mailgun` is
supported for Teleport Enterprise (Cloud).

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

Complete Mailgun integration by providing the following Mailgun API
configuration values:

**`Domain`**: Configures the Mailgun sending domain.

**`Mailgun Private Key`**: Configures the Mailgun API key.

</Details>

Check failure on line 41 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": 41, "column": 1}}}, "severity": "ERROR"}
## Prerequisites

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