Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Fix some docs #7899

Merged
merged 22 commits into from
Jul 29, 2020
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
86372a6
Remove trusted_third_party_id_servers from new configs (#5536)
aaronraimist Jul 18, 2020
5a98362
Update password reset documentation (#7782)
aaronraimist Jul 18, 2020
237d2e8
Various updates to README
aaronraimist Jul 18, 2020
6d435b5
Remove hot spare language from README (#7076)
aaronraimist Jul 18, 2020
b9d8563
Document how to write time periods in homeserver.yaml (#6609)
aaronraimist Jul 18, 2020
f9f7179
Fix synctl.ronn (#4413)
aaronraimist Jul 18, 2020
68e1d27
Add disk space considerations to Postgres porting instructions (#6545)
aaronraimist Jul 18, 2020
d23094e
Attempt to document client Well-Known URI (#6528, #4672)
aaronraimist Jul 18, 2020
9f3f713
Add changelog
aaronraimist Jul 18, 2020
3a15a66
Add Debian changelog
aaronraimist Jul 21, 2020
6d911bb
Amend changelog
aaronraimist Jul 21, 2020
fd61afc
Fix sample config generation
aaronraimist Jul 21, 2020
2e396b1
Mention public_baseurl in client well-known setup
aaronraimist Jul 21, 2020
6670c10
Update INSTALL.md
aaronraimist Jul 24, 2020
b104566
Merge branch 'develop' into fix-docs
aaronraimist Jul 26, 2020
ee78e19
Merge branch 'fix-docs' of github.com:aaronraimist/synapse into fix-docs
aaronraimist Jul 26, 2020
0e25e86
Move information on PostgreSQL from README to INSTALL.md
aaronraimist Jul 26, 2020
fb4624b
Update info on downstream Debian packages
aaronraimist Jul 26, 2020
e142115
Improve docs for downstream Debian and Ubuntu packages
aaronraimist Jul 26, 2020
efc03d7
Typo
aaronraimist Jul 27, 2020
880268a
Change username, hopefully this isn't confusing
aaronraimist Jul 29, 2020
7dc673b
Merge branch 'develop' into fix-docs
aaronraimist Jul 29, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix synctl.ronn (#4413)
Signed-off-by: Aaron Raimist <[email protected]>
aaronraimist committed Jul 18, 2020

Verified

This commit was signed with the committer’s verified signature.
aaronraimist Aaron Raimist
commit f9f71790e7fcffcba9cec84a579d589a7602839e
27 changes: 14 additions & 13 deletions debian/synctl.ronn
Original file line number Diff line number Diff line change
@@ -46,19 +46,20 @@ Configuration file may be generated as follows:
## ENVIRONMENT

* `SYNAPSE_CACHE_FACTOR`:
Synapse's architecture is quite RAM hungry currently - a lot of
recent room data and metadata is deliberately cached in RAM in
order to speed up common requests. This will be improved in
future, but for now the easiest way to either reduce the RAM usage
(at the risk of slowing things down) is to set the
SYNAPSE_CACHE_FACTOR environment variable. Roughly speaking, a
SYNAPSE_CACHE_FACTOR of 1.0 will max out at around 3-4GB of
resident memory - this is what we currently run the matrix.org
on. The default setting is currently 0.1, which is probably around
a ~700MB footprint. You can dial it down further to 0.02 if
desired, which targets roughly ~512MB. Conversely you can dial it
up if you need performance for lots of users and have a box with a
lot of RAM.
Synapse's architecture is quite RAM hungry currently - we deliberately
cache a lot of recent room data and metadata in RAM in order to speed up
common requests. We'll improve this in the future, but for now the easiest
way to either reduce the RAM usage (at the risk of slowing things down)
is to set the almost-undocumented ``SYNAPSE_CACHE_FACTOR`` environment
variable. The default is 0.5, which can be decreased to reduce RAM usage
in memory constrained enviroments, or increased if performance starts to
degrade.

However, degraded performance due to a low cache factor, common on
machines with slow disks, often leads to explosions in memory use due
backlogged requests. In this case, reducing the cache factor will make
things worse. Instead, try increasing it drastically. 2.0 is a good
starting value.

## COPYRIGHT