Skip to content
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -151,19 +151,19 @@ configure the Slack plugin to use these credentials. You will also configure the
plugin to notify the right Slack channels when it receives an Access Request
update.

### Create a config file
### Create a configuration file

<Tabs>
<TabItem label="Executable">
The Teleport Slack plugin uses a config file in TOML format. Generate a
boilerplate config by running the following command (the plugin will not run
<TabItem label="Executable or Docker">
The Teleport Slack plugin uses a configuration file in TOML format. Generate a
boilerplate configuration by running the following command (the plugin will not run
unless the config file is in `/etc/teleport-slack.toml`):

```code
$ teleport-slack configure | sudo tee /etc/teleport-slack.toml > /dev/null
```

This should result in a config file like the one below:
This should result in a configuration file like the one below:

```toml
(!examples/resources/plugins/teleport-slack.toml!)
Expand All @@ -181,7 +181,7 @@ based on the following example:
</TabItem>
</Tabs>

### Edit the config file
### Edit the configuration file

Open the configuration file created for the Teleport Slack plugin and update the following fields:

Expand All @@ -205,7 +205,7 @@ receives an Access Request from the Auth Service, it will look up the role being
requested and identify the Slack channels to notify.

<Tabs>
<TabItem label="Executable">
<TabItem label="Executable or Docker">
Here is an example of a `role_to_recipients` map:

```toml
Expand Down Expand Up @@ -263,7 +263,7 @@ by adding the following to your `role_to_recipients` config (replace
earlier):

<Tabs>
<TabItem label="Executable">
<TabItem label="Executable or Docker">
```toml
[role_to_recipients]
"*" = "access-requests"
Expand Down Expand Up @@ -314,6 +314,13 @@ INFO Starting Teleport Access Slack Plugin 7.2.1: slack/app.go:80
INFO Plugin is ready slack/app.go:101
```
</TabItem>
<TabItem label="Docker">
run the plugin:

```code
$ docker run -v <path-to-config>:/etc/teleport-slack.toml public.ecr.aws/gravitational/teleport-plugin-slack:(=teleport.version=) start
```
</TabItem>
<TabItem label="Helm Chart">
Install the plugin:

Expand Down