mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-28 20:08:31 +01:00
543f2a5c76
* Update docs/configuring-playbook-bridge-appservice-kakaotalk.md: fix the header for adjusting the playbook configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Move sections "Set up Double Puppeting" under "Usage" as subsections for mautrix bridges and appservice kakaotalk
The changes in this commit reflect double puppeting configuration flow. Since the docs claim that double puppeting can be set up after enabling bridges by chatting with the bridge's bot, the explanation about double puppeting may well be placed under "Usage" as subsection.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove notes about setting up double puppeting manually
Since this method is explained after configuring bridges, those notes are no longer necessary.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs for mautrix and kakaotalk bridges: add prerequisite(s) section for instructing to install Appservice Double Puppet and/or Shared Secret Auth service
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace "Enabling Appservice Double Puppet" with "This"
Enabling Appservice Double Puppet is contrasted with "Enabling double puppeting by enabling the Shared Secret Auth service", therefore it can be just called as "this" if Shared Secret Auth service is not mentioned below.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-beeper-linkedin.md: follow other instances
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add 💡 (Light Bulb: U+1F4A1) to the headings
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
51 lines
3.0 KiB
Markdown
51 lines
3.0 KiB
Markdown
# Setting up Mautrix Twitter bridging (optional)
|
|
|
|
**Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) bridge supported by the playbook.
|
|
|
|
The playbook can install and configure [mautrix-twitter](https://github.com/mautrix/twitter) for you.
|
|
|
|
See the project's [documentation](https://github.com/mautrix/twitter) to learn what it does and why it might be useful to you.
|
|
|
|
## Prerequisite (optional)
|
|
|
|
If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook.
|
|
|
|
For details about configuring Double Puppeting for this bridge, see the section below: [Set up Double Puppeting](#-set-up-double-puppeting)
|
|
|
|
## Adjusting the playbook configuration
|
|
|
|
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
|
|
|
```yaml
|
|
matrix_mautrix_twitter_enabled: true
|
|
```
|
|
|
|
## Installing
|
|
|
|
After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
|
|
|
## 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](https://docs.mau.fi/bridges/python/twitter/authentication.html).
|
|
|
|
### 💡 Set up Double Puppeting
|
|
|
|
After successfully enabling bridging, you may wish to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do).
|
|
|
|
To set it up, you have 2 ways of going about it.
|
|
|
|
#### Method 1: automatically, by enabling Appservice Double Puppet or Shared Secret Auth
|
|
|
|
The bridge automatically performs Double Puppeting if [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook.
|
|
|
|
Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) 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](configuring-playbook-shared-secret-auth.md) 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](https://github.com/mautrix/twitter/blob/master/ROADMAP.md) under Misc/Manual login with `login-matrix`
|