diff options
| author | Sumner Evans <me@sumnerevans.com> | 2021-11-01 05:35:55 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-01 11:35:55 +0000 |
| commit | ece84f2c450d986e54acc80971225fb02f4e1d05 (patch) | |
| tree | e107d9590f3ed5965a6756cc9eb599058ecb0905 /docs/message_retention_policies.md | |
| parent | Add metrics to the threadpools (#11178) (diff) | |
| download | synapse-ece84f2c450d986e54acc80971225fb02f4e1d05.tar.xz | |
Improve code formatting and fix a few typos in docs (#11221)
* Labeled a lot more code blocks with the appropriate type * Fixed a couple of minor typos (missing/extraneous commas) Signed-off-by: Sumner Evans <me@sumnerevans.com>
Diffstat (limited to 'docs/message_retention_policies.md')
| -rw-r--r-- | docs/message_retention_policies.md | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/message_retention_policies.md b/docs/message_retention_policies.md index ea3d46cc10..9214d6d7e9 100644 --- a/docs/message_retention_policies.md +++ b/docs/message_retention_policies.md @@ -69,9 +69,9 @@ A default policy can be defined as such, in the `retention` section of the configuration file: ```yaml - default_policy: - min_lifetime: 1d - max_lifetime: 1y +default_policy: + min_lifetime: 1d + max_lifetime: 1y ``` Here, `min_lifetime` and `max_lifetime` have the same meaning and level @@ -95,14 +95,14 @@ depending on an event's room's policy. This can be done by setting the file. An example of such configuration could be: ```yaml - purge_jobs: - - longest_max_lifetime: 3d - interval: 12h - - shortest_max_lifetime: 3d - longest_max_lifetime: 1w - interval: 1d - - shortest_max_lifetime: 1w - interval: 2d +purge_jobs: + - longest_max_lifetime: 3d + interval: 12h + - shortest_max_lifetime: 3d + longest_max_lifetime: 1w + interval: 1d + - shortest_max_lifetime: 1w + interval: 2d ``` In this example, we define three jobs: @@ -141,8 +141,8 @@ purging old events in a room. These limits can be defined as such in the `retention` section of the configuration file: ```yaml - allowed_lifetime_min: 1d - allowed_lifetime_max: 1y +allowed_lifetime_min: 1d +allowed_lifetime_max: 1y ``` The limits are considered when running purge jobs. If necessary, the |