From ab2a615cfb13f8ff91919c4332fcb182640d5484 Mon Sep 17 00:00:00 2001 From: Shay <hillerys@element.io> Date: Thu, 19 May 2022 07:46:33 -0700 Subject: [PATCH] Update configuration manual to document size-related suffixes (#12777) --- changelog.d/12777.doc | 2 ++ docs/usage/configuration/config_documentation.md | 8 ++++++++ 2 files changed, 10 insertions(+) create mode 100644 changelog.d/12777.doc diff --git a/changelog.d/12777.doc b/changelog.d/12777.doc new file mode 100644 index 0000000000..cc9c07704d --- /dev/null +++ b/changelog.d/12777.doc @@ -0,0 +1,2 @@ +Update configuration manual documentation to document size-related suffixes. + 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: -- GitLab