Add dedicated variables for controlling Kakaotalk encryption

This commit is contained in:
Slavi Pantaleev 2022-07-25 14:58:36 +03:00
parent 7b937cf9a9
commit d14e499365
3 changed files with 7 additions and 19 deletions

View File

@ -26,23 +26,7 @@ There are some additional things you may wish to configure about the bridge.
Take a look at: Take a look at:
- `roles/matrix-bridge-appservice-kakaotalk/defaults/main.yml` for some variables that you can customize via your `vars.yml` file - `roles/matrix-bridge-appservice-kakaotalk/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
- `roles/matrix-bridge-appservice-kakaotalk/templates/config.yaml.j2` for the bridge's default configuration. You can override settings using the `matrix_appservice_kakaotalk_configuration_extension_yaml` variable - `roles/matrix-bridge-appservice-kakaotalk/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_kakaotalk_configuration_extension_yaml` variable
Here's some example configuration (which goes into your `vars.yml` file):
```yaml
# This configuration:
# - enables encryption (it's off by default)
# - grants some user on your homeserver 'admin' access to the bridge
# (note: the user specified in the `matrix_admin` (part of `roles/matrix-base/defaults/main.yml`) is made an admin by default)
matrix_appservice_kakaotalk_configuration_extension_yaml: |
bridge:
permissions:
'@YOUR_USERNAME:{{ matrix_domain }}': admin
encryption:
allow: true
default: true
```
### Set up Double Puppeting ### Set up Double Puppeting

View File

@ -119,6 +119,10 @@ matrix_appservice_kakaotalk_bridge_permissions: |
matrix_appservice_kakaotalk_appservice_bot_username: kakaotalkbot matrix_appservice_kakaotalk_appservice_bot_username: kakaotalkbot
matrix_appservice_kakaotalk_user_prefix: 'kakaotalk_as_' matrix_appservice_kakaotalk_user_prefix: 'kakaotalk_as_'
# End-to-bridge encryption configuration
matrix_appservice_kakaotalk_bridge_encryption_allow: false
matrix_appservice_kakaotalk_bridge_encryption_default: "{{ matrix_appservice_kakaotalk_bridge_encryption_allow }}"
# Specifies the default log level for all bridge loggers. # Specifies the default log level for all bridge loggers.
matrix_appservice_kakaotalk_logging_level: WARNING matrix_appservice_kakaotalk_logging_level: WARNING

View File

@ -133,10 +133,10 @@ bridge:
# application service. # application service.
encryption: encryption:
# Allow encryption, work in group chat rooms with e2ee enabled # Allow encryption, work in group chat rooms with e2ee enabled
allow: false allow: {{ matrix_appservice_kakaotalk_bridge_encryption_allow | to_json }}
# Default to encryption, force-enable encryption in all portals the bridge creates # Default to encryption, force-enable encryption in all portals the bridge creates
# This will cause the bridge bot to be in private chats for the encryption to work properly. # This will cause the bridge bot to be in private chats for the encryption to work properly.
default: false default: {{ matrix_appservice_kakaotalk_bridge_encryption_default| to_json }}
# Options for automatic key sharing. # Options for automatic key sharing.
key_sharing: key_sharing:
# Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled. # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.