matrix-org/synapse

Update docs about Synapse from Debian's repos

Open

#16,214 opened on Aug 30, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (11,713 stars) (2,196 forks)batch import
A-DocsO-OccasionalS-MinorT-DefectZ-Help-Wantedgood first issue

Description

Synapse was removed from Debian bookworm at the end of May on the grounds that this project could not guarantee code reviews of CVE backports. There are also open security issues in sid, although it technically remains installable there.

The documentation offering Debian's own repo as an installation option as "maintained" is therefore out of date and should be updated, perhaps merging it with the Ubuntu section below until the situation changes.

(I think this situation is unfortunate because installing an additional repo is a hurdle to usage, and 1.78 could still have been a reasonable support target, but this issue is just about updating the documentation.)

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Locate the installation documentation file (likely synapse/docs/setup/installation.md). Find the 'Downstream Debian packages' section and update it to note that Synapse was removed from Debian bookworm and has open security issues in sid, so Debian's repo is no longer maintained. Consider merging with the Ubuntu section as suggested. Reference the Debian bug (https://bugs.debian.org/1036806) and the tracker page for context. Ensure the changes are consistent with the rest of the doc.