teleport/docs/pages/reference/helm-reference/teleport-plugin-slack.mdx

---
title: teleport-plugin-slack Chart Reference
description: Values that can be set using the teleport-plugin-slack Helm chart
---

The `teleport-plugin-slack` Helm chart is used to configure the Slack Teleport plugin, which allows users to receive Access Requests via channels or direct messages in Slack.

You can [browse the source on GitHub](https://github.com/gravitational/teleport-plugins/tree/v(=teleport.version=)/charts/access/slack).

This reference details available values for the `teleport-plugin-slack` chart.

(!docs/pages/includes/backup-warning.mdx!)

## `teleport.address`

| Type | Default value | Required? |
| - | - | - |
| `string` | `""` | Yes |

This parameter contains the host/port combination of the Teleport Proxy
Service (or the Auth Service if you are configuring your plugin to
connect to it directly).

<Tabs>
  <TabItem label="values.yaml">
  ```yaml
  teleport:
    address: "teleport.example.com:3025"
  ```
  </TabItem>
  <TabItem label="--set">
  ```code
  $ --set teleport.address="teleport.example.com:3025"
  ```
  </TabItem>
</Tabs>

## `teleport.identitySecretName`

| Type | Default value | Required? |
| - | - | - |
| `string` | `""` | Yes |

Name of the Kubernetes secret that contains the credentials for the connection
to your Teleport cluster.

The secret should be in the following format:

```yaml
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: teleport-plugin-slack-identity
data:
  auth_id: ...
```

Check out the [Access Requests with
Slack](../../access-controls/access-request-plugins/ssh-approval-slack.mdx) guide
for more information about how to acquire these credentials.

<Tabs>
  <TabItem label="values.yaml">
  ```yaml
  teleport:
    identitySecretName: "teleport-plugin-slack-identity"
  ```
  </TabItem>
  <TabItem label="--set">
  ```code
  $ --set teleport.identitySecretName="teleport-plugin-slack-identity"
  ```
  </TabItem>
</Tabs>

## `teleport.identitySecretPath`

| Type | Default value | Required? |
| - | - | - |
| `string` | `"auth_id"` | No |

The key in the Kubernetes secret specified by `teleport.identitySecretName` that holds the
credentials for the connection to your Teleport cluster. If the secret has the path,
`"auth_id"`, you can omit this field.

<Tabs>
  <TabItem label="values.yaml">
  ```yaml
  teleport:
    identitySecretPath: "auth_id"
  ```
  </TabItem>
  <TabItem label="--set">
  ```code
  $ --set teleport.identitySecretPath="auth_id"
  ```
  </TabItem>
</Tabs>

## `slack.token`

| Type | Default value | Required? |
| - | - | - |
| `string` | `""` | No |

Slack token of the bot user to impersonate when sending Access Request
messages. Ignored when `slack.tokenFromSecret` is set.
It's only recommended for testing purposes. Please use
[`slack.tokenFromSecret`](#slacktokenfromsecret) instead.

<Tabs>
  <TabItem label="values.yaml">
  ```yaml
  slack:
    token: "xoxb-1234"
  ```
  </TabItem>
  <TabItem label="--set">
  ```code
  $ --set slack.token="xoxb-1234"
  ```
  </TabItem>
</Tabs>

## `slack.tokenFromSecret`

| Type | Default value | Required? |
| - | - | - |
| `string` | `""` | No |

Secret containing the Slack token of the bot user.

<Tabs>
  <TabItem label="values.yaml">
  ```yaml
  slack:
    tokenFromSecret: "teleport-slack-plugin-token"
  ```
  </TabItem>
  <TabItem label="--set">
  ```code
  $ --set slack.tokenFromSecret="teleport-slack-plugin-token"
  ```
  </TabItem>
</Tabs>

## `slack.tokenSecretPath`

| Type | Default value | Required? |
| - | - | - |
| `string` | `""` | No |

Key where the token is located inside the secret specified by `slack.tokenFromSecret`.

<Tabs>
  <TabItem label="values.yaml">
  ```yaml
  slack:
    tokenSecretPath: "token"
  ```
  </TabItem>
  <TabItem label="--set">
  ```code
  $ --set slack.tokenSecretPath="token"
  ```
  </TabItem>
</Tabs>

## `roleToRecipients`

| Type | Default value | Required? |
| - | - | - |
| `map` | `{}` | Yes |

Mapping of roles to a list of channels and Slack emails. It must contain
a mapping for `*` in case no matching roles are found.

<Tabs>
  <TabItem label="values.yaml">
  ```yaml
  roleToRecipients:
    dev: ["dev-access-requests", "user@example.com"]
    "*": ["access-requests"]
  ```
  </TabItem>
  <TabItem label="--set">
  ```code
  $ --set "roleToRecipients.dev[0]=dev-access-requests,roleToRecipients.dev[1]=user@example.com,roleToRecipients.\*[0]=access-requests"
  ```
  </TabItem>
</Tabs>

## `log.output`

| Type | Default value | Required? |
| - | - | - |
| `string` | `stdout` | No |

Logger output. Could be `stdout`, `stderr` or a file name, eg. `/var/log/teleport/slack.log`

<Tabs>
  <TabItem label="values.yaml">
  ```yaml
  log:
    output: /var/log/teleport/slack.log
  ```
  </TabItem>
  <TabItem label="--set">
  ```code
  $ --set log.output="/var/log/teleport/slack.log"
  ```
  </TabItem>
</Tabs>

## `log.severity`

| Type | Default value | Required? |
| - | - | - |
| `string` | `INFO` | No |

Logger severity. Possible values are `INFO`, `ERROR`, `DEBUG` or `WARN`.

<Tabs>
  <TabItem label="values.yaml">
  ```yaml
  log:
    severity: DEBUG
  ```
  </TabItem>
  <TabItem label="--set">
  ```code
  $ --set log.severity="DEBUG"
  ```
  </TabItem>
</Tabs>