summary refs log tree commit diff
path: root/docs/sample_config.yaml
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2020-05-27 13:17:01 +0100
committerGitHub <noreply@github.com>2020-05-27 13:17:01 +0100
commit4ba55559acf56a041e47ec0d74890d4ad3e0ddb7 (patch)
tree40c55ade601b4dcf6260bef9f25f6ed2e82e0215 /docs/sample_config.yaml
parentDon't apply cache factor to event cache. (#7578) (diff)
downloadsynapse-4ba55559acf56a041e47ec0d74890d4ad3e0ddb7.tar.xz
Fix specifying cache factors via env vars with * in name. (#7580)
This mostly applise to `*stateGroupCache*` and co.

Broke in #6391.
Diffstat (limited to 'docs/sample_config.yaml')
-rw-r--r--docs/sample_config.yaml6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 0e1be153c7..48f273b0b2 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -643,6 +643,12 @@ caches:
    # takes priority over setting through the config file.
    # Ex. SYNAPSE_CACHE_FACTOR_GET_USERS_WHO_SHARE_ROOM_WITH_USER=2.0
    #
+   # Some caches have '*' and other characters that are not
+   # alphanumeric or underscores. These caches can be named with or
+   # without the special characters stripped. For example, to specify
+   # the cache factor for `*stateGroupCache*` via an environment
+   # variable would be `SYNAPSE_CACHE_FACTOR_STATEGROUPCACHE=2`.
+   #
    per_cache_factors:
      #get_users_who_share_room_with_user: 2.0