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

Document how to deploy plugins #8944

Open
erikjohnston opened this issue Dec 15, 2020 · 3 comments
Open

Document how to deploy plugins #8944

erikjohnston opened this issue Dec 15, 2020 · 3 comments
Labels
A-Docs things relating to the documentation T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements.

Comments

@erikjohnston
Copy link
Member

erikjohnston commented Dec 15, 2020 •
edited by babolivier
Loading

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:

  1. How to write a plugin, e.g the function signatures of __init__ and parse_config, (see docs)
  2. How to deploy these plugins in practice (i.e. make them a python package and install them in the venv?)
@erikjohnston erikjohnston added the A-Docs things relating to the documentation label Dec 15, 2020
@erikjohnston erikjohnston mentioned this issue Dec 15, 2020
Open
jaywink added a commit that referenced this issue Mar 10, 2021
@jaywink
Fix spam checker modules documentation example
4fea56e 
A parse_config method is mandatory on spam checked modules.

This relates to #8944 as well.

Signed-off-by: Jason Robinson <jasonr@matrix.org>
@jaywink jaywink mentioned this issue Mar 10, 2021
Merged
@babolivier
Copy link
Contributor

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.

@babolivier babolivier changed the title Document how to write plugins Document how to deploy plugins Apr 6, 2022
@babolivier babolivier added the T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements. label Apr 6, 2022
@richvdh
Copy link
Member

richvdh commented Apr 6, 2022

related: #9944.

@jrlmontejo
Copy link

I think the cookie cutter template for Synapse modules should be mentioned in the docs:
https://github.com/matrix-org/synapse-module-cookiecutter-template

@dklimpel dklimpel mentioned this issue Aug 2, 2022
Merged
4 tasks
@matrixbot matrixbot mentioned this issue Dec 21, 2023
Open
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
A-Docs things relating to the documentation T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@richvdh @babolivier @erikjohnston @jrlmontejo