From 72b302e4f36a50bbf4b936ebe46912db99a826a0 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 31 Dec 2024 12:27:36 -0500 Subject: [PATCH] Update docs for mautrix bridges: remove descriptions about permissions in favor of the common one on docs/configuring-playbook-bridge-mautrix-bridges.md Signed-off-by: Suguru Hirahara --- ...-playbook-bridge-mautrix-meta-instagram.md | 28 ----------------- ...-playbook-bridge-mautrix-meta-messenger.md | 30 ------------------- ...figuring-playbook-bridge-mautrix-signal.md | 29 ------------------ 3 files changed, 87 deletions(-) diff --git a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md index 72fee820d..b4cab914c 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md @@ -35,34 +35,6 @@ matrix_mautrix_meta_instagram_enabled: true Before proceeding to [re-running the playbook](./installing.md), you may wish to adjust the configuration further. See below. -### 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 - -The permissions are following the sequence: nothing < `relay` < `user` < `admin`. - -The default permissions are set via `matrix_mautrix_meta_instagram_bridge_permissions_default` and are somewhat like this: - -```yaml -matrix_mautrix_meta_instagram_bridge_permissions_default: - '*': relay - example.com: user - '{{ matrix_admin }}': admin -``` - -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 -matrix_mautrix_meta_instagram_bridge_permissions_custom: - '@alice:{{ matrix_domain }}': admin -``` - ### Extending the configuration There are some additional things you may wish to configure about the bridge. diff --git a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md index 3c38d20ce..afe864ba8 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md @@ -48,36 +48,6 @@ You may switch the mode via the `matrix_mautrix_meta_messenger_meta_mode` variab Note that switching the mode (especially between `facebook*` and `messenger`) will intentionally make the bridge use another database (`matrix_mautrix_meta_facebook` or `matrix_mautrix_meta_messenger`) to isolate the 2 instances. Switching between Tor and non-Tor may be possible without dataloss, but your mileage may vary. Before switching to a new mode, you may wish to de-configure the old one (send `help` to the bridge bot and unbridge your portals, etc.). -### 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 - -The permissions are following the sequence: nothing < `relay` < `user` < `admin`. - -The default permissions are set via `matrix_mautrix_meta_messenger_bridge_permissions_default` and are somewhat like this: - -```yaml -matrix_mautrix_meta_messenger_bridge_permissions_default: - '*': relay - example.com: user - '{{ matrix_admin }}': admin -``` - -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 -matrix_mautrix_meta_messenger_bridge_permissions_custom: - '@alice:{{ matrix_domain }}': admin -``` - -You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2` to find more information on the permissions settings and other options you would like to configure. - ### Extending the configuration There are some additional things you may wish to configure about the bridge. diff --git a/docs/configuring-playbook-bridge-mautrix-signal.md b/docs/configuring-playbook-bridge-mautrix-signal.md index 7fedf106e..578030e27 100644 --- a/docs/configuring-playbook-bridge-mautrix-signal.md +++ b/docs/configuring-playbook-bridge-mautrix-signal.md @@ -26,35 +26,6 @@ To enable the bridge, add the following configuration to your `inventory/host_va matrix_mautrix_signal_enabled: true ``` -### 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 - -The permissions are following the sequence: nothing < `relay` < `user` < `admin`. - -The default permissions are set via `matrix_mautrix_signal_bridge_permissions` and are somewhat like this: - -```yaml -matrix_mautrix_signal_bridge_permissions: - '*': relay - example.com: user - '{{ matrix_admin }}': admin -``` - -In case you want to replace the default permissions settings **completely**, populate the following item within your `vars.yml` file: - -```yaml -matrix_mautrix_signal_bridge_permissions: - '@alice:{{ matrix_domain }}': admin - '@bob:{{ matrix_domain }}' : user -``` - ### Extending the configuration There are some additional things you may wish to configure about the bridge.