summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2019-06-14 19:37:59 +0100
committerGitHub <noreply@github.com>2019-06-14 19:37:59 +0100
commitf12e1f029c5e805548438ffea2d125e0fdb39467 (patch)
tree11b748b10216dce60a554244fec530cd5ede7cfc /docs
parentMerge pull request #5461 from matrix-org/erikj/histograms_are_cumalitive (diff)
parentAdd plugin APIs for implementations of custom event rules. (diff)
downloadsynapse-f12e1f029c5e805548438ffea2d125e0fdb39467.tar.xz
Merge pull request #5440 from matrix-org/babolivier/third_party_event_rules
Allow server admins to define implementations of extra rules for allowing or denying incoming events
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 4d7e6f3eb5..bd80d97a93 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -1351,3 +1351,16 @@ password_config:
 #    alias: "*"
 #    room_id: "*"
 #    action: allow
+
+
+# Server admins can define a Python module that implements extra rules for
+# allowing or denying incoming events. In order to work, this module needs to
+# override the methods defined in synapse/events/third_party_rules.py.
+#
+# This feature is designed to be used in closed federations only, where each
+# participating server enforces the same rules.
+#
+#third_party_event_rules:
+#  module: "my_custom_project.SuperRulesSet"
+#  config:
+#    example_option: 'things'