Skip to content
Snippets Groups Projects
Unverified Commit ab2a615c authored by Shay's avatar Shay Committed by GitHub
Browse files

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

parent 684feeaf
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
changelog.d/12777.doc 0 → 100644
+ 2
− 0
View file @ ab2a615c
Update configuration manual documentation to document size-related suffixes.
docs/usage/configuration/config_documentation.md
+ 8
− 0
View file @ ab2a615c
...@@ -23,6 +23,14 @@ followed by a letter. Letters have the following meanings: ...@@ -23,6 +23,14 @@ followed by a letter. Letters have the following meanings:
For example, setting `redaction_retention_period: 5m` would remove redacted For example, setting `redaction_retention_period: 5m` would remove redacted
messages from the database after 5 minutes, rather than 5 months. 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 ### YAML
The configuration file is a [YAML](https://yaml.org/) file, which means that certain syntax rules 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: apply if you want your config file to be read properly. A few helpful things to know:
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment