summary refs log tree commit diff
path: root/docs/sample_config.yaml
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2019-06-05 16:32:35 +0100
committerRichard van der Hoff <richard@matrix.org>2019-06-05 16:32:35 +0100
commit7603a706eb96305d804da05030a71288fcc255ab (patch)
treed59bcc7827bc6b038d5c3e7bc46677a84007e255 /docs/sample_config.yaml
parentUpdate sample config (diff)
parentFix `federation_custom_ca_list` configuration option. (diff)
downloadsynapse-7603a706eb96305d804da05030a71288fcc255ab.tar.xz
Merge branch 'rav/fix_custom_ca' into rav/enable_tls_verification
Diffstat (limited to 'docs/sample_config.yaml')
-rw-r--r--docs/sample_config.yaml16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index d10a355d68..2f37e71601 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -261,6 +261,22 @@ listeners:
 
 # Monthly Active User Blocking
 #
+# Used in cases where the admin or server owner wants to limit to the
+# number of monthly active users.
+#
+# 'limit_usage_by_mau' disables/enables monthly active user blocking. When
+# anabled and a limit is reached the server returns a 'ResourceLimitError'
+# with error type Codes.RESOURCE_LIMIT_EXCEEDED
+#
+# 'max_mau_value' is the hard limit of monthly active users above which
+# the server will start blocking user actions.
+#
+# 'mau_trial_days' is a means to add a grace period for active users. It
+# means that users must be active for this number of days before they
+# can be considered active and guards against the case where lots of users
+# sign up in a short space of time never to return after their initial
+# session.
+#
 #limit_usage_by_mau: False
 #max_mau_value: 50
 #mau_trial_days: 2