This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Repository navigation
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Document how to deploy plugins #8944
Description
We have plugin support used in various places, some of these are documented to a greater or lesser extent (e.g SSO mapping providers), but we should have a generic doc they can all point to explaining:
How to write a plugin, e.g the function signatures of(see docs)__init__andparse_config,- How to deploy these plugins in practice (i.e. make them a python package and install them in the venv?)
Activity
Fix spam checker modules documentation example
babolivier commentedon Apr 6, 2022
The first point is already covered in https://matrix-org.github.io/synapse/latest/modules/writing_a_module.html
So I'm going to rename this issue to cover only the second one.
[-]Document how to write plugins[/-][+]Document how to deploy plugins[/+]richvdh commentedon Apr 6, 2022
related: #9944.
jrlmontejo commentedon May 24, 2022
I think the cookie cutter template for Synapse modules should be mentioned in the docs:
https://github.com/matrix-org/synapse-module-cookiecutter-template