Get rid of matrix_mautrix_signal_configuration_permissions

While it's kind of nice having it, it's also somewhat raw
and unnecessary.

Having a good default and not even mentioning it seems better
for most users.

People who need a more exposed bridge (rare) can use
override the default configuration using
`matrix_mautrix_signal_configuration_extension_yaml`.
This commit is contained in:
Slavi Pantaleev 2021-01-03 08:06:32 +02:00
parent aac400664a
commit da2a6682b3
4 changed files with 3 additions and 28 deletions

View file

@ -12,24 +12,6 @@ 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
```yaml
bridge:
permissions:
```
in [the example config in mautrix-signal](https://github.com/tulir/mautrix-signal/blob/master/mautrix_signal/example-config.yaml).
For instance, use
```yaml
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](https://github.com/ansible/ansible/issues/17324#issuecomment-449642731) on how to use variable names as dictionary keys.)
## Set up Double Puppeting
If you'd like to use [Double Puppeting](https://github.com/tulir/mautrix-whatsapp/wiki/Authentication#replacing-whatsapp-accounts-matrix-puppet-with-matrix-account) (hint: you most likely do), you have 2 ways of going about it.

View file

@ -67,15 +67,6 @@ matrix_mautrix_signal_login_shared_secret: ''
# or completely replace this variable with your own template.
matrix_mautrix_signal_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
# Permitted values:
# user - Use the bridge with puppeting.
# admin - Use and administrate the bridge.
# Permitted keys:
# * - All Matrix users
# domain - All users on that homeserver
# mxid - Specific user
matrix_mautrix_signal_configuration_permissions: {}
matrix_mautrix_signal_configuration_extension_yaml: |
# Your custom YAML configuration goes here.
# This configuration extends the default starting configuration (`matrix_mautrix_signal_configuration_yaml`).

View file

@ -25,3 +25,4 @@
- {'old': 'matrix_mautrix_signal_db_host', 'new': 'matrix_mautrix_signal_database_hostname'}
- {'old': 'matrix_mautrix_signal_db_port', 'new': 'matrix_mautrix_signal_database_port'}
- {'old': 'matrix_mautrix_signal_db_url', 'new': 'matrix_mautrix_signal_database_connection_string'}
- {'old': 'matrix_mautrix_signal_configuration_permissions', 'new': '<superseded by matrix_mautrix_signal_configuration_extension_yaml>'}

View file

@ -172,7 +172,8 @@ bridge:
# * - All Matrix users
# domain - All users on that homeserver
# mxid - Specific user
permissions: {{ matrix_mautrix_signal_configuration_permissions }}
permissions:
'{{ matrix_mautrix_signal_homeserver_domain }}': user
# Python logging configuration.