element-hq / element-hq/synapse
Document how to deploy plugins
- Dominant language
- Python
- Stars
- 4.6k
- Forks
- 600
- Avg merge
- 5d 22h
- Merged PRs (30d)
- 51
Description
This issue has been migrated from [#8944](https://github.com/matrix-org/synapse/issues/8944).
---
We have plugin support used in various places, some of these are documented to a greater or lesser extent (e.g [SSO mapping providers](https://github.com/matrix-org/synapse/blob/develop/docs/sso_mapping_providers.md)), but we should have a generic doc they can all point to explaining:
1. ~How to write a plugin, e.g the function signatures of `__init__` and `parse_config`,~ (see [docs](https://matrix-org.github.io/synapse/latest/modules/writing_a_module.html))
2. How to deploy these plugins in practice (i.e. make them a python package and install them in the venv?)
Contributor guide
Assessment
This issue has not been assessed yet.