feat(mx-puppet-slack): add support for OAuth client ID/secret
The OAuth credentials method seems to be the only viable way to configure the mx-puppet-bridge now. Legacy tokens can no longer be created, and the other methods (xoxs and xoxc tokens) come with warnings about them being against Slack's terms of service.
This commit is contained in:
parent
11c0dcf2ac
commit
7ae70c27e6
|
@ -1,20 +1,33 @@
|
||||||
# Setting up MX Puppet Slack (optional)
|
# Setting up MX Puppet Slack (optional)
|
||||||
|
|
||||||
**Note**: bridging to [Slack](https://slack.com) can also happen via the [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) bridge supported by the playbook.
|
**Note**: bridging to [Slack](https://slack.com) can also happen via the
|
||||||
|
[matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md)
|
||||||
|
bridge supported by the playbook.
|
||||||
|
|
||||||
The playbook can install and configure
|
The playbook can install and configure
|
||||||
[mx-puppet-slack](https://github.com/Sorunome/mx-puppet-slack) for you.
|
[mx-puppet-slack](https://github.com/Sorunome/mx-puppet-slack) for you.
|
||||||
|
|
||||||
See the project page to learn what it does and why it might be useful to you.
|
See the project page to learn what it does and why it might be useful to you.
|
||||||
|
|
||||||
To enable the [Slack](https://slack.com/) bridge just use the following
|
## Setup
|
||||||
playbook configuration:
|
|
||||||
|
|
||||||
|
To enable the [Slack](https://slack.com/) bridge:
|
||||||
|
|
||||||
```yaml
|
1. Follow the
|
||||||
matrix_mx_puppet_slack_enabled: true
|
[OAuth credentials](https://github.com/Sorunome/mx-puppet-slack#option-2-oauth)
|
||||||
```
|
instructions to create a new Slack app, setting the redirect URL to
|
||||||
|
`https://matrix.YOUR_DOMAIN/slack/oauth`.
|
||||||
|
2. Update your `vars.yml` with the following:
|
||||||
|
```yaml
|
||||||
|
matrix_mx_puppet_slack_enabled: true
|
||||||
|
# Client ID must be quoted so YAML does not parse it as a float.
|
||||||
|
matrix_mx_puppet_slack_oauth_client_id: "<SLACK_APP_CLIENT_ID>"
|
||||||
|
matrix_mx_puppet_slack_oauth_client_secret: "<SLACK_APP_CLIENT_SECRET>"
|
||||||
|
```
|
||||||
|
3. Run playbooks with `setup-all` and `start` tags:
|
||||||
|
```
|
||||||
|
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
|
@ -3,6 +3,9 @@
|
||||||
|
|
||||||
matrix_mx_puppet_slack_enabled: true
|
matrix_mx_puppet_slack_enabled: true
|
||||||
|
|
||||||
|
matrix_mx_puppet_slack_oauth_client_id: ''
|
||||||
|
matrix_mx_puppet_slack_oauth_client_secret: ''
|
||||||
|
|
||||||
matrix_mx_puppet_slack_container_image_self_build: false
|
matrix_mx_puppet_slack_container_image_self_build: false
|
||||||
matrix_mx_puppet_slack_container_image_self_build_repo: "https://github.com/Sorunome/mx-puppet-slack.git"
|
matrix_mx_puppet_slack_container_image_self_build_repo: "https://github.com/Sorunome/mx-puppet-slack.git"
|
||||||
|
|
||||||
|
|
|
@ -18,6 +18,10 @@ bridge:
|
||||||
# Slack OAuth settings. Create a slack app at https://api.slack.com/apps
|
# Slack OAuth settings. Create a slack app at https://api.slack.com/apps
|
||||||
oauth:
|
oauth:
|
||||||
enabled: true
|
enabled: true
|
||||||
|
# Slack app credentials.
|
||||||
|
# N.B. This must be quoted so YAML does not parse it as a float.
|
||||||
|
clientId: '{{ matrix_mx_puppet_slack_oauth_client_id }}'
|
||||||
|
clientSecret: '{{ matrix_mx_puppet_slack_oauth_client_secret }}'
|
||||||
# Path where to listen for OAuth redirect callbacks.
|
# Path where to listen for OAuth redirect callbacks.
|
||||||
redirectPath: {{ matrix_mx_puppet_slack_redirect_path }}
|
redirectPath: {{ matrix_mx_puppet_slack_redirect_path }}
|
||||||
# Set up proxying from https://your.domain/redirect_path to http://bindAddress:port/redirect_path,
|
# Set up proxying from https://your.domain/redirect_path to http://bindAddress:port/redirect_path,
|
||||||
|
|
Loading…
Reference in a new issue