mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-11-13 05:52:50 +01:00
35 lines
1.1 KiB
Markdown
35 lines
1.1 KiB
Markdown
|
# Setting up MX Puppet Twitter (optional)
|
||
|
|
|
||
|
|
The playbook can install and configure
|
||
|
|
[mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter) for you.
|
||
|
|
|
||
|
|
See the project page to learn what it does and why it might be useful to you.
|
||
|
|
|
||
|
|
To enable the [Twitter](https://twitter.com) bridge, make an app on [developer.twitter.com](https://developer.twitter.com/en/apps)
|
||
|
|
and fill out the following playbook configuration.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
matrix_mx_puppet_twitter_enabled: true
|
||
|
|
matrix_mx_puppet_twitter_consumer_key: ''
|
||
|
|
matrix_mx_puppet_twitter_consumer_secret: ''
|
||
|
|
matrix_mx_puppet_twitter_access_token: ''
|
||
|
|
matrix_mx_puppet_twitter_access_token_secret: ''
|
||
|
|
matrix_mx_puppet_twitter_environment: ''
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Once the bot is enabled you need to start a chat with `Twitter Puppet Bridge` with
|
||
|
|
the handle `@_twitterpuppet_bot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base
|
||
|
|
domain, not the `matrix.` domain).
|
||
|
|
|
||
|
|
To log in, use `link` and click the link.
|
||
|
|
|
||
|
|
Once logged in, send `list` to the bot user to list the available rooms.
|
||
|
|
|
||
|
|
Clicking rooms in the list will result in you receiving an invitation to the
|
||
|
|
bridged room.
|
||
|
|
|
||
|
|
Also send `help` to the bot to see the commands available.
|