Browse Source

Add the encryption section to example-config.yaml

Gary Kramlich 3 years ago
parent
commit
7630e8a7a9
1 changed files with 23 additions and 0 deletions
  1. 23 0
      example-config.yaml

+ 23 - 0
example-config.yaml

@@ -111,6 +111,29 @@ bridge:
         # Optional extra text sent when joining a management room.
         additional_help: ""
 
+    # End-to-bridge encryption support options.
+    #
+    # See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
+    encryption:
+        # Allow encryption, work in group chat rooms with e2ee enabled
+        allow: false
+        # 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.
+        # It is recommended to also set private_chat_portal_meta to true when using this.
+        default: false
+        # Options for automatic key sharing.
+        key_sharing:
+            # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
+            # You must use a client that supports requesting keys from other users to use this feature.
+            allow: false
+            # Require the requesting device to have a valid cross-signing signature?
+            # This doesn't require that the bridge has verified the device, only that the user has verified it.
+            # Not yet implemented.
+            require_cross_signing: false
+            # Require devices to be verified by the bridge?
+            # Verification by the bridge is not yet implemented.
+            require_verification: true
+
 logging:
   directory: ./logs
   file_name_format: '{{.Date}}-{{.Index}}.log'