summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2019-05-28 16:55:10 +0100
committerBrendan Abolivier <babolivier@matrix.org>2019-05-28 16:55:10 +0100
commit4aba561c65c842e640861035e3937e78ab950a21 (patch)
tree33c93c0be75d8f80855545c0f687e28a2d54eba2 /docs
parentAllow configuring a range for the account validity startup job (diff)
downloadsynapse-4aba561c65c842e640861035e3937e78ab950a21.tar.xz
Config and changelog
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index f658ec8ecd..8ff53d5cb4 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -755,11 +755,18 @@ uploads_path: "DATADIR/uploads"
 # after that the validity period changes and Synapse is restarted, the users'
 # expiration dates won't be updated unless their account is manually renewed.
 #
+# If set, the ``startup_job_max_delta`` optional setting will make the startup job
+# described above set a random expiration date between t + period  and
+# t + period + startup_job_max_delta, t being the date and time at which the job
+# sets the expiration date for a given user. This is useful for server admins that
+# want to avoid Synapse sending a lot of renewal emails at once.
+#
 #account_validity:
 #  enabled: True
 #  period: 6w
 #  renew_at: 1w
 #  renew_email_subject: "Renew your %(app)s account"
+#  startup_job_max_delta: 2d
 
 # The user must provide all of the below types of 3PID when registering.
 #