Update configuration manual to document size-related suffixes (#12777)

matrix-org · May 19, 2022 · ab2a615 · ab2a615
1 parent 684feea
commit ab2a615
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/changelog.d/12777.doc 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
@@ -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:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Update configuration manual documentation to document size-related suffixes.