2020-06-29 14:28:43 +02:00
# Setting up MX Puppet Twitter (optional)
2021-12-22 15:53:53 +02:00
**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.
2024-10-18 20:27:30 +02:00
The playbook can install and configure [mx-puppet-twitter ](https://github.com/Sorunome/mx-puppet-twitter ) for you.
2020-06-29 14:28:43 +02:00
See the project page to learn what it does and why it might be useful to you.
2024-10-12 13:48:24 +02:00
## Prerequisite
Make an app on [developer.twitter.com ](https://developer.twitter.com/en/apps ).
## Adjusting the playbook configuration
2024-10-17 15:17:56 +02:00
To enable the [Twitter ](https://twitter.com ) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
2020-06-29 14:28:43 +02:00
```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: ''
```
2024-10-12 20:03:46 +02:00
## Installing
After configuring the playbook, run the [installation ](installing.md ) command: `just install-all` or `just setup-all`
2020-06-29 14:28:43 +02:00
## Usage
2024-10-18 20:27:30 +02:00
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).
2020-06-29 14:28:43 +02:00
To log in, use `link` and click the link.
Once logged in, send `list` to the bot user to list the available rooms.
2024-10-18 20:27:30 +02:00
Clicking rooms in the list will result in you receiving an invitation to the bridged room.
2020-06-29 14:28:43 +02:00
Also send `help` to the bot to see the commands available.