mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-29 12:27:14 +01:00
41 lines
1.6 KiB
Markdown
41 lines
1.6 KiB
Markdown
# Setting up MX Puppet Twitter bridging (optional)
|
|
|
|
**Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mautrix-twitter](configuring-playbook-bridge-mautrix-twitter.md) bridge supported by the playbook.
|
|
|
|
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.
|
|
|
|
## Prerequisite
|
|
|
|
Make an app on [developer.twitter.com](https://developer.twitter.com/en/apps).
|
|
|
|
## Adjusting the playbook configuration
|
|
|
|
To enable the [Twitter](https://twitter.com) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
|
|
|
```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: ''
|
|
```
|
|
|
|
## Installing
|
|
|
|
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
|
|
|
## Usage
|
|
|
|
Once the bot is enabled you need to start a chat with `Twitter Puppet Bridge` with the handle `@_twitterpuppet_bot:example.com` (where `example.com` 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.
|