summary refs log tree commit diff
path: root/docs/.sample_config_header.yaml
diff options
context:
space:
mode:
authorAaron Raimist <aaron@raim.ist>2020-07-29 09:35:44 -0500
committerGitHub <noreply@github.com>2020-07-29 10:35:44 -0400
commit2184f61faeb5ce88c05d28913e3f881813c0c5dd (patch)
treed4bda7da6465c1087cab52b46053d4e65e94f25a /docs/.sample_config_header.yaml
parentConvert storage layer to async/await. (#7963) (diff)
downloadsynapse-2184f61faeb5ce88c05d28913e3f881813c0c5dd.tar.xz
Various improvements to the docs (#7899)
Diffstat (limited to 'docs/.sample_config_header.yaml')
-rw-r--r--docs/.sample_config_header.yaml11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/.sample_config_header.yaml b/docs/.sample_config_header.yaml

index 35a591d042..8c9b31acdb 100644 --- a/docs/.sample_config_header.yaml +++ b/docs/.sample_config_header.yaml
@@ -10,5 +10,16 @@ # homeserver.yaml. Instead, if you are starting from scratch, please generate # a fresh config using Synapse by following the instructions in INSTALL.md. +# Configuration options that take a time period can be set using a number +# followed by a letter. Letters have the following meanings: +# s = second +# m = minute +# h = hour +# d = day +# w = week +# y = year +# For example, setting redaction_retention_period: 5m would remove redacted +# messages from the database after 5 minutes, rather than 5 months. + ################################################################################