element-hq / element-hq/synapse

We have two ways of specifying global cache factors

Open
#13,484 0 comments 0 reactions 0 assignees View on GitHub
A-Config A-Docs O-Uncommon S-Tolerable T-Task Z-Dev-Wishlist
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

This issue has been migrated from [#13484](https://github.com/matrix-org/synapse/issues/13484).

---

The env var `SYNAPSE_CACHE_FACTOR` and config `caches.global_factor`. I suggest we get rid of the former and explain how to migrate for admins.

The env var is currently documented alongside the config option in the config manual.

Contributor guide

Open the contributing guide

Research direction

Start with the config manual section that documents SYNAPSE_CACHE_FACTOR and caches.global_factor, then inspect references to both names. Done means the redundant environment variable is removed and the manual clearly explains the migration for administrators.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.