summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorNeil Johnson <neil@matrix.org>2019-10-24 11:48:46 +0100
committerRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2019-10-24 11:48:46 +0100
commit2794b79052f96b8103ce2b710959853313a82e90 (patch)
treec7741a1e807878cba3a13d7fe90f79e0dc308db4 /docs
parentCleanup extra quotes from IDEs (#6236) (diff)
downloadsynapse-2794b79052f96b8103ce2b710959853313a82e90.tar.xz
Option to suppress resource exceeded alerting (#6173)
The expected use case is to suppress MAU limiting on small instances
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index b4dd146f06..6c81c0db75 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -241,7 +241,6 @@ listeners:
 #
 #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
 #
@@ -261,9 +260,16 @@ listeners:
 # sign up in a short space of time never to return after their initial
 # session.
 #
+# 'mau_limit_alerting' is a means of limiting client side alerting
+# should the mau limit be reached. This is useful for small instances
+# where the admin has 5 mau seats (say) for 5 specific people and no
+# interest increasing the mau limit further. Defaults to True, which
+# means that alerting is enabled
+#
 #limit_usage_by_mau: false
 #max_mau_value: 50
 #mau_trial_days: 2
+#mau_limit_alerting: false
 
 # If enabled, the metrics for the number of monthly active users will
 # be populated, however no one will be limited. If limit_usage_by_mau