configuring-playbook-bridge-mx-puppet-twitter.md

Setting up MX Puppet Twitter bridging (optional)

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

The playbook can install and configure 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.

Adjusting the playbook configuration

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

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 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.