element-hq / element-hq/synapse

Expand and improve workers documentation and example configuration

Open
#9,072 0 comments 0 reactions 0 assignees View on GitHub
A-Docs A-Workers S-Minor T-Task
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

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

---

A general call;
- Add more documentation surrounding workers (just in general)
- [ ] Add example configuration file (a-la `sample_config.yaml`) for each worker type, or for all workers in one
- [ ] Add docker-compose file that includes ready-to-work example for synapse workers

Imo: Currently i think workers are very hard to set up or figure out on its own, because knowledge of it is mostly limited to large setups, and thus that knowledge is never reflected in documentation, or workers seen as an asset to be documented with the same priority.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.