Parcourir la source

Update docs for mautrix bridges: adopt common descriptions about bridge permissions

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3914/head
Suguru Hirahara il y a 1 an
Parent
révision
94765e6ce3
Aucune clé connue n'a été trouvée dans la base pour cette signature ID de la clé GPG: E4F9743DAB4B7B75
4 fichiers modifiés avec 10 ajouts et 22 suppressions
  1. +2
    -0
      docs/configuring-playbook-bridge-mautrix-bridges.md
  2. +0
    -2
      docs/configuring-playbook-bridge-mautrix-meta-instagram.md
  3. +0
    -2
      docs/configuring-playbook-bridge-mautrix-meta-messenger.md
  4. +8
    -18
      docs/configuring-playbook-bridge-mautrix-signal.md

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-bridges.md Voir le fichier

@@ -27,6 +27,8 @@ Different levels of permission can be granted to users. For example, to **config
matrix_admin: "@alice:{{ matrix_domain }}" 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: **Alternatively** (more verbose, but allows multiple admins to be configured), you can do the same on a per-bridge basis with:


```yaml ```yaml


+ 0
- 2
docs/configuring-playbook-bridge-mautrix-meta-instagram.md Voir le fichier

@@ -56,8 +56,6 @@ matrix_mautrix_meta_instagram_bridge_permissions_default:
'{{ matrix_admin }}': admin '{{ 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: 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 ```yaml


+ 0
- 2
docs/configuring-playbook-bridge-mautrix-meta-messenger.md Voir le fichier

@@ -69,8 +69,6 @@ matrix_mautrix_meta_messenger_bridge_permissions_default:
'{{ matrix_admin }}': admin '{{ 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: 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 ```yaml


+ 8
- 18
docs/configuring-playbook-bridge-mautrix-signal.md Voir le fichier

@@ -26,37 +26,27 @@ To enable the bridge, add the following configuration to your `inventory/host_va
matrix_mautrix_signal_enabled: true 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. By default, any user on your homeserver will be able to use the bridge.


Different levels of permission can be granted to users: 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 ```yaml
permissions:
matrix_mautrix_signal_bridge_permissions:
'*': relay '*': relay
example.com: user 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: In case you want to replace the default permissions settings **completely**, populate the following item within your `vars.yml` file:


```yaml ```yaml


Chargement…
Annuler
Enregistrer