summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorNeil Johnson <neil@matrix.org>2019-06-05 13:16:23 +0100
committerGitHub <noreply@github.com>2019-06-05 13:16:23 +0100
commit26713515de97c98dda99a9b06325781fe09b1cbe (patch)
tree6924347b199a04d387f44f3e59847e6af96fadd6 /docs
parentAdd a test room version where we enforce key validity (#5348) (diff)
downloadsynapse-26713515de97c98dda99a9b06325781fe09b1cbe.tar.xz
Neilj/mau tracking config explainer (#5284)
Improve documentation of monthly active user blocking and mau_trial_days
Diffstat (limited to 'docs')
-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 493ea9ee9e..0960b9b5ed 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