3.2 KiB
Setting up Mautrix Signal (optional)
The playbook can install and configure mautrix-signal for you.
See the project's documentation to learn what it does and why it might be useful to you.
Note/Prerequisite: If you're running with the Postgres database server integrated by the playbook (which is the default), you don't need to do anything special and can easily proceed with installing. However, if you're using an external Postgres server, you'd need to manually prepare a Postgres database for this bridge and adjust the variables related to that (matrix_mautrix_signal_database_*).
Use the following playbook configuration:
matrix_mautrix_signal_enabled: true
To specify which users have access to the bridge, use the variable matrix_mautrix_signal_configuration_permissions.
Refer to the documentation for
bridge:
permissions:
in the example config in mautrix-signal. For instance, use
matrix_mautrix_signal_configuration_permissions: |
{
'{{ matrix_domain }}': 'user'
}
to allow all users registered to the current host's matrix domain access to the bridge, or hard-code whatever you like. (See this issue on how to use variable names as dictionary keys.)
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 Shared Secret Auth
The bridge will automatically perform Double Puppeting if you enable Shared Secret Auth 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
Note: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see Usage).
When using this method, each user that wishes to enable Double Puppeting needs to follow the following steps:
- retrieve a Matrix access token for yourself. You can use the following command:
curl \
--data '{"identifier": {"type": "m.id.user", "user": "YOUR_MATRIX_USERNAME" }, "password": "YOUR_MATRIX_PASSWORD", "type": "m.login.password", "device_id": "Mautrix-Signal", "initial_device_display_name": "Mautrix-Signal"}' \
https://matrix.DOMAIN/_matrix/client/r0/login
-
send the access token to the bot. Example:
login-matrix MATRIX_ACCESS_TOKEN_HERE -
make sure you don't log out the
Mautrix-Signaldevice some time in the future, as that would break the Double Puppeting feature
Usage
You then need to start a chat with @signalbot:YOUR_DOMAIN (where YOUR_DOMAIN is your base domain, not the matrix. domain).