diff options
| author | Shay <hillerys@element.io> | 2022-02-11 11:05:20 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-11 11:05:20 -0800 |
| commit | b2b971f28a19c7fb31df79db29060ae72ba06e6b (patch) | |
| tree | c52ac988207d255ce8fdf4ab8cf4d6f607ef1a9f /docs | |
| parent | Support the MSC3715 for `/relations`. (#11941) (diff) | |
| download | synapse-b2b971f28a19c7fb31df79db29060ae72ba06e6b.tar.xz | |
Enable cache time-based expiry by default (#11849)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sample_config.yaml | 13 | ||||
| -rw-r--r-- | docs/upgrade.md | 7 |
2 files changed, 16 insertions, 4 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 946cd281d2..d2bb3d4208 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -751,11 +751,16 @@ caches: per_cache_factors: #get_users_who_share_room_with_user: 2.0 - # Controls how long an entry can be in a cache without having been - # accessed before being evicted. Defaults to None, which means - # entries are never evicted based on time. + # Controls whether cache entries are evicted after a specified time + # period. Defaults to true. Uncomment to disable this feature. # - #expiry_time: 30m + #expire_caches: false + + # If expire_caches is enabled, this flag controls how long an entry can + # be in a cache without having been accessed before being evicted. + # Defaults to 30m. Uncomment to set a different time to live for cache entries. + # + #cache_entry_ttl: 30m # Controls how long the results of a /sync request are cached for after # a successful response is returned. A higher duration can help clients with diff --git a/docs/upgrade.md b/docs/upgrade.md index 6f20000295..25a86c08e6 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -111,6 +111,13 @@ to: Please update any relevant reverse proxy or firewall configurations appropriately. +## Time-based cache expiry is now enabled by default + +Formerly, entries in the cache were not evicted regardless of whether they were accessed after storing. +This behavior has now changed. By default entries in the cache are now evicted after 30m of not being accessed. +To change the default behavior, go to the `caches` section of the config and change the `expire_caches` and +`cache_entry_ttl` flags as necessary. Please note that these flags replace the `expiry_time` flag in the config. + ## Deprecation of `capability` `org.matrix.msc3283.*` The `capabilities` of MSC3283 from the REST API `/_matrix/client/r0/capabilities` |