You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
36 lines
1.8 KiB
36 lines
1.8 KiB
4 years ago
|
# Setting up Mautrix Twitter (optional)
|
||
|
|
|
||
|
|
The playbook can install and configure [mautrix-twitter](https://github.com/tulir/mautrix-twitter) for you.
|
||
|
|
|
||
|
|
See the project's [documentation](https://github.com/tulir/mautrix-twitter/wiki#usage) to learn what it does and why it might be useful to you.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
matrix_mautrix_twitter_enabled: true
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Set up Double Puppeting
|
||
|
|
|
||
|
|
If you'd like to use [Double Puppeting](https://github.com/tulir/mautrix-twitter/wiki/Authentication#double-puppeting) (hint: you most likely do), you have 2 ways of going about it.
|
||
|
|
|
||
|
|
### Method 1: automatically, by enabling Shared Secret Auth
|
||
|
|
|
||
|
|
The bridge will automatically perform Double Puppeting if you enable [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook.
|
||
|
|
|
||
|
|
This is the recommended way of setting up Double Puppeting, as it's easier to accomplish, works for all your users automatically, and has less of a chance of breaking in the future.
|
||
|
|
|
||
|
|
### Method 2: manually, by asking each user to provide a working access token
|
||
|
|
|
||
|
|
This method is currently not available for the Mautrix-Twitter bridge, but is on the [roadmap](https://github.com/tulir/mautrix-twitter/blob/master/ROADMAP.md) under Misc/Manual login with `login-matrix`
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
1. You then need to start a chat with `@twitterbot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain).
|
||
|
|
2. Send login-cookie to start the login. The bot should respond with instructions on how to proceed.
|
||
|
|
|
||
|
|
You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/twitter/authentication.html).
|
||
|
|
|
||
|
|
If you run into trouble, check the [Troubleshooting](#troubleshooting) section below.
|
||
|
|
|
||
|
|
After successfully enabling bridging, you may wish to [set up Double Puppeting](#set-up-double-puppeting), if you haven't already done so.
|