summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2022-05-19 07:46:33 -0700
committerGitHub <noreply@github.com>2022-05-19 07:46:33 -0700
commitab2a615cfb13f8ff91919c4332fcb182640d5484 (patch)
tree59ce040e59425df9209326cfcadeb4f65a8a2f48 /docs
parentProperly close providers.json file stream. (#12794) (diff)
downloadsynapse-ab2a615cfb13f8ff91919c4332fcb182640d5484.tar.xz
Update configuration manual to document size-related suffixes (#12777)
Diffstat (limited to 'docs')
-rw-r--r--docs/usage/configuration/config_documentation.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 6b9ffc09d2..525e1c7a91 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -23,6 +23,14 @@ followed by a letter. Letters have the following meanings:
 For example, setting `redaction_retention_period: 5m` would remove redacted
 messages from the database after 5 minutes, rather than 5 months.
 
+In addition, configuration options referring to size use the following suffixes:
+
+* `M` = MiB, or 1,048,576 bytes
+* `K` = KiB, or 1024 bytes 
+
+For example, setting `max_avatar_size: 10M` means that Synapse will not accept files larger than 10,485,760 bytes
+for a user avatar. 
+
 ### YAML 
 The configuration file is a [YAML](https://yaml.org/) file, which means that certain syntax rules
 apply if you want your config file to be read properly. A few helpful things to know: