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

Update worker docs with recent enhancements #7969

Merged
merged 26 commits into from
Jul 29, 2020
Merged
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
2278562
Update worker documentation with latest additions
erikjohnston Jul 28, 2020
a880415
Add some of the new worker options to sample config
erikjohnston Jul 28, 2020
43df3fd
Newsfile
erikjohnston Jul 28, 2020
48ba564
Update docs/workers.md
erikjohnston Jul 28, 2020
5494d0c
Update synapse/config/redis.py
erikjohnston Jul 28, 2020
3e6af96
Update synapse/config/redis.py
erikjohnston Jul 28, 2020
8bd0b08
Update synapse/config/workers.py
erikjohnston Jul 28, 2020
b91e4fb
Update docs/workers.md
erikjohnston Jul 28, 2020
3dd4b73
Apply suggestions from code review
erikjohnston Jul 28, 2020
1fe0335
s/master/main/
erikjohnston Jul 28, 2020
dad0be0
Add back some notes about redis dependencies
erikjohnston Jul 28, 2020
31191fa
Clarify the 'federation_sender_instances' config
erikjohnston Jul 28, 2020
5d8a970
sample config
erikjohnston Jul 28, 2020
196e585
Review suggestions
erikjohnston Jul 29, 2020
21ef5cd
Add notes about installing Redis
erikjohnston Jul 29, 2020
8741ac7
Move fedearation shard config to worker config
erikjohnston Jul 29, 2020
c375b15
Note that redis must be enabled when using workers
erikjohnston Jul 29, 2020
63263ef
Fix sample config
erikjohnston Jul 29, 2020
6c78895
Apply suggestions from code review
erikjohnston Jul 29, 2020
9d891f8
Move config file explanation up
erikjohnston Jul 29, 2020
af26701
Move note about historical apps down
erikjohnston Jul 29, 2020
a236824
Doc worker_listeners
erikjohnston Jul 29, 2020
753c4f3
Specify what the room ID is in the path
erikjohnston Jul 29, 2020
308b181
Mention explicitly which streams can be moved off master
erikjohnston Jul 29, 2020
09aebbc
Move synctl worker config to seperate file
erikjohnston Jul 29, 2020
49e804b
Add architectural diagram
erikjohnston 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
Add back some notes about redis dependencies
erikjohnston committed Jul 29, 2020
commit dad0be0491a578aa4f4afe060717a08b9155088a
11 changes: 11 additions & 0 deletions docs/workers.md
Original file line number Diff line number Diff line change
@@ -35,6 +35,17 @@ Redis, which relays replication commands between processes. This can give a
significant cpu saving on the main process and will be a prerequisite for
upcoming performance improvements.

If using Redis the appropriate dependencies must be installed. If using a
virtual env these can be installed by:

```sh
pip install matrix-synapse[redis]
```
richvdh marked this conversation as resolved.
Show resolved Hide resolved

Note that these dependencies are included if synapse was installed with `[all]`,
erikjohnston marked this conversation as resolved.
Show resolved Hide resolved
or if using the debian packages from matrix.org.
erikjohnston marked this conversation as resolved.
Show resolved Hide resolved
erikjohnston marked this conversation as resolved.
Show resolved Hide resolved



## Configuration