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

Fixup worker doc (again) #8000

Merged
merged 5 commits into from
Aug 6, 2020
Merged

Fixup worker doc (again) #8000

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e59dc9a
Fixup worker doc (again)
erikjohnston Jul 30, 2020
f581366
Newsfile
erikjohnston Jul 30, 2020
8d33692
Add back headings
erikjohnston Jul 31, 2020
5a249e5
Update systemd worker example
erikjohnston Aug 3, 2020
da55885
Add migration notes
erikjohnston Aug 4, 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
17 changes: 17 additions & 0 deletions docs/workers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,23 @@ all these to be folded into the `generic_worker` app and to use config to define
which processes handle the various proccessing such as push notifications.


## Migration from old config
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd have split this up and had two separate "migration" sections, but this is fine.


There are two main independent changes that have been made: introducing Redis
support and merging apps into `synapse.app.generic_worker`. Both these changes
are backwards compatible and so no changes to the config are required, however
server admins are encouraged to plan to migrate to Redis as the old style direct
TCP replication config is deprecated.

To migrate to Redis add the `redis` config as above, and optionally remove the
TCP `replication` listener from master and `worker_replication_port` from worker
config.

To migrate apps to use `synapse.app.generic_worker` simply update the
`worker_app` option in the worker configs, and where worker are started (e.g.
in systemd service files, but not required for synctl).


## Architectural diagram

The following shows an example setup using Redis and a reverse proxy:
Expand Down