summary refs log tree commit diff
path: root/synapse
diff options
context:
space:
mode:
authorNeil Johnson <neil@matrix.org>2018-08-17 13:58:25 +0100
committerNeil Johnson <neil@matrix.org>2018-08-17 13:58:25 +0100
commit0195dfbf52f3cd8e93068e7b108b64f426dba2ff (patch)
treeb1b3f6e84565c679bb16d7e7039d3e1d8e73806d /synapse
parentadd new error type ResourceLimit (diff)
downloadsynapse-0195dfbf52f3cd8e93068e7b108b64f426dba2ff.tar.xz
server limits config docs
Diffstat (limited to 'synapse')
-rw-r--r--synapse/config/server.py26
1 files changed, 26 insertions, 0 deletions
diff --git a/synapse/config/server.py b/synapse/config/server.py
index ae72c872d9..a41c48e69c 100644
--- a/synapse/config/server.py
+++ b/synapse/config/server.py
@@ -341,6 +341,32 @@ class ServerConfig(Config):
           # - port: 9000
           #   bind_addresses: ['::1', '127.0.0.1']
           #   type: manhole
+
+
+          # Homeserver blocking
+          #
+          # How to reach the server admin, used in ResourceLimitError
+          # admin_uri: 'mailto:admin@server.com'
+          #
+          # Global block config
+          #
+          # hs_disabled: False
+          # hs_disabled_message: 'Human readable reason for why the HS is blocked'
+          # hs_disabled_limit_type: 'error code(str), to help clients decode reason'
+          #
+          # Monthly Active User Blocking
+          #
+          # Enables monthly active user checking
+          # limit_usage_by_mau: False
+          # max_mau_value: 50
+          #
+          # Sometimes the server admin will want to ensure certain accounts are
+          # never blocked by mau checking. These accounts are specified here.
+          #
+          # mau_limit_reserved_threepids:
+          # - medium: 'email'
+          #   address: 'reserved_user@example.com'
+
         """ % locals()
 
     def read_arguments(self, args):