From 94765e6ce3b32f13f32d9b5185b52189d186940a Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 31 Dec 2024 11:08:47 -0500 Subject: [PATCH] Update docs for mautrix bridges: adopt common descriptions about bridge permissions Signed-off-by: Suguru Hirahara --- ...iguring-playbook-bridge-mautrix-bridges.md | 2 ++ ...-playbook-bridge-mautrix-meta-instagram.md | 2 -- ...-playbook-bridge-mautrix-meta-messenger.md | 2 -- ...figuring-playbook-bridge-mautrix-signal.md | 26 ++++++------------- 4 files changed, 10 insertions(+), 22 deletions(-) diff --git a/docs/configuring-playbook-bridge-mautrix-bridges.md b/docs/configuring-playbook-bridge-mautrix-bridges.md index 24576ab94..a53305663 100644 --- a/docs/configuring-playbook-bridge-mautrix-bridges.md +++ b/docs/configuring-playbook-bridge-mautrix-bridges.md @@ -27,6 +27,8 @@ Different levels of permission can be granted to users. For example, to **config matrix_admin: "@alice:{{ matrix_domain }}" ``` +If you don't define the `matrix_admin` in your configuration (e.g. `matrix_admin: @alice:example.com`), then there's no admin by default. + **Alternatively** (more verbose, but allows multiple admins to be configured), you can do the same on a per-bridge basis with: ```yaml diff --git a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md index 2e7105f24..72fee820d 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md @@ -56,8 +56,6 @@ matrix_mautrix_meta_instagram_bridge_permissions_default: '{{ matrix_admin }}': admin ``` -If you don't define the `matrix_admin` in your configuration (e.g. `matrix_admin: @alice:example.com`), then there's no admin by default. - You may redefine `matrix_mautrix_meta_instagram_bridge_permissions_default` any way you see fit, or add extra permissions using `matrix_mautrix_meta_instagram_bridge_permissions_custom` like this: ```yaml diff --git a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md index b9194fef6..3c38d20ce 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md @@ -69,8 +69,6 @@ matrix_mautrix_meta_messenger_bridge_permissions_default: '{{ matrix_admin }}': admin ``` -If you don't define the `matrix_admin` in your configuration (e.g. `matrix_admin: @alice:example.com`), then there's no admin by default. - You may redefine `matrix_mautrix_meta_messenger_bridge_permissions_default` any way you see fit, or add extra permissions using `matrix_mautrix_meta_messenger_bridge_permissions_custom` like this: ```yaml diff --git a/docs/configuring-playbook-bridge-mautrix-signal.md b/docs/configuring-playbook-bridge-mautrix-signal.md index 5edda9708..7fedf106e 100644 --- a/docs/configuring-playbook-bridge-mautrix-signal.md +++ b/docs/configuring-playbook-bridge-mautrix-signal.md @@ -26,37 +26,27 @@ To enable the bridge, add the following configuration to your `inventory/host_va matrix_mautrix_signal_enabled: true ``` -There are some additional things you may wish to configure about the bridge before you continue. +### Bridge permissions By default, any user on your homeserver will be able to use the bridge. Different levels of permission can be granted to users: -* relay - Allowed to be relayed through the bridge, no access to commands; -* user - Use the bridge with puppeting; -* admin - Use and administer the bridge. +- `relay` - Allowed to be relayed through the bridge, no access to commands +- `user` - Use the bridge with puppeting +- `admin` - Use and administer the bridge -The permissions are following the sequence: nothing < relay < user < admin. +The permissions are following the sequence: nothing < `relay` < `user` < `admin`. -The default permissions are set as follows: +The default permissions are set via `matrix_mautrix_signal_bridge_permissions` and are somewhat like this: ```yaml -permissions: +matrix_mautrix_signal_bridge_permissions: '*': relay example.com: user + '{{ matrix_admin }}': admin ``` -If you want to augment the preset permissions, you might want to set the additional permissions with the following settings in your `vars.yml` file: - -```yaml -matrix_mautrix_signal_configuration_extension_yaml: | - bridge: - permissions: - '@alice:{{ matrix_domain }}': admin -``` - -This will add the admin permission to the specific user, while keeping the default permissions. - In case you want to replace the default permissions settings **completely**, populate the following item within your `vars.yml` file: ```yaml