element-hq / element-hq/synapse

Create a machine-readable document for routing requests to workers

Open
#12,139 0 comments 0 reactions 0 assignees View on GitHub
A-Workers T-Enhancement
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

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

---

Constructing a reverse-proxy configuration for routing requests to workers is currently left largely as an exercise for the reader in https://matrix-org.github.io/synapse/develop/workers.html.

I think we should maintain a single source of truth which documents a mapping between endpoints and workers, which could ultimately be used as an input to other scripts which construct configuration files suitable for various reverse-proxies.

Contributor guide

Open the contributing guide

Research direction

Start with the worker routing guidance in https://matrix-org.github.io/synapse/develop/workers.html and review how endpoint-to-worker mappings are currently described. Done means there is a maintained machine-readable source of truth that documents the mapping and can serve as input for reverse-proxy configuration generation.

Written by the indexing model from the issue text.

Assessment

Domain
devops, documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.