Skip to content

Latest commit

 

History

History
44 lines (24 loc) · 2.57 KB

configuring-playbook-bridge-mautrix-twitter.md

File metadata and controls

44 lines (24 loc) · 2.57 KB
Raw

Setting up Mautrix Twitter (optional)

Note: bridging to Twitter can also happen via the mx-puppet-twitter bridge supported by the playbook.

The playbook can install and configure mautrix-twitter for you.

See the project's documentation to learn what it does and why it might be useful to you.

Adjusting the playbook configuration

To enable the bridge, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:

matrix_mautrix_twitter_enabled: true

Installing

After configuring the playbook, run the installation command: just install-all or just setup-all

Set up Double Puppeting

If you'd like to use Double Puppeting (hint: you most likely do), you have 2 ways of going about it.

Method 1: automatically, by enabling Appservice Double Puppet or Shared Secret Auth

The bridge will automatically perform Double Puppeting if you enable the Appservice Double Puppet service or the Shared Secret Auth service for this playbook.

Enabling Appservice Double Puppet 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.

Enabling double puppeting by enabling the Shared Secret Auth service works at the time of writing, but is deprecated and will stop working 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 under Misc/Manual login with login-matrix

Usage

  1. You then need to start a chat with @twitterbot:example.com (where example.com 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.

After successfully enabling bridging, you may wish to set up Double Puppeting, if you haven't already done so.