diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx index 0314082c269b5..8f481ba8d6234 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx @@ -32,8 +32,7 @@ regularly. ## Step 1/7. Define RBAC resources -Before you set up the email plugin, you will need to enable Role Access Requests -in your Teleport cluster. +Before you set up the email plugin, enable Role Access Requests in your Teleport cluster. (!/docs/pages/includes/plugins/editor-request-rbac.mdx!) @@ -42,11 +41,11 @@ in your Teleport cluster.
If you are using a local SMTP server to test the plugin, you should install the -plugin on your local machine. This is because the plugin needs to dial out to -your SMTP server and perform any necessary DNS lookups in order to send email. +plugin on your local machine to ensure the plugin can connect to the SMTP server +and perform any necessary DNS lookups to send email. -Your Teleport cluster does *not* need to perform DNS lookups for your plugin, as -the plugin dials out to the Proxy Service or Auth Service. +Your Teleport cluster does *not* need to perform DNS lookups for your plugin +because the plugin dials out to the Teleport Proxy Service or Teleport Auth Service.
@@ -94,10 +93,10 @@ chosen recipients. ### Create a config file - + -The Teleport email plugin uses a config file in TOML format. Generate a -boilerplate config by running the following command: +The Teleport email plugin uses a configuration file in TOML format. Generate a +boilerplate configuration by running the following command: ```code $ teleport-email configure | sudo tee /etc/teleport-email.toml @@ -109,14 +108,14 @@ The email plugin Helm Chart uses a YAML values file to configure the plugin. On your local workstation, create a file called `teleport-email-helm.yaml` based on the following example: -```toml +```yaml (!examples/resources/plugins/teleport-email-helm.yaml!) ``` -### Edit the config file +### Edit the configuration file Edit the configuration file for your environment. We will show you how to set each value below. @@ -212,7 +211,7 @@ it will look up the role being requested and identify the recipients to notify. Here is an example of a `role_to_recipients` map: - + ```toml [role_to_recipients] @@ -264,7 +263,7 @@ by adding the following to your `role_to_recipients` config, replacing `YOUR_EMAIL_ADDRESS` with the appropriate address: - + ```toml [role_to_recipients] "*" = "YOUR_EMAIL_ADDRESS" @@ -287,7 +286,7 @@ Teleport email plugin to notify a static list of recipients for every Access Request event by using the `delivery.recipients` field: - + ```toml [delivery] recipients = ["eng@exmaple.com", "dev@example.com"] @@ -310,7 +309,7 @@ recipient list to a `role_to_recipients` mapping under the wildcard value `"*"`. You configuration should resemble the following: - + ```toml # /etc/teleport-email.toml @@ -394,6 +393,13 @@ INFO Starting Teleport Access Email Plugin (): email/app.go:80 INFO Plugin is ready email/app.go:101 ``` + +Start the plugin: + +```code +$ docker run -v :/etc/teleport-email.toml public.ecr.aws/gravitational/teleport-plugin-email:(=teleport.version=) start +``` + Install the plugin: