From 3e18808e9f3a97954f6f5dabb4f3bda7362cba75 Mon Sep 17 00:00:00 2001 From: MadLittleMods Date: Mon, 15 Sep 2025 14:48:41 +0000 Subject: [PATCH] deploy: 769d30a247926dd90d9afe7f6afd65bdc605d465 --- develop/deprecation_policy.html | 41 ++++++++++++++++++++++++++++----- develop/print.html | 41 ++++++++++++++++++++++++++++----- develop/searchindex.js | 2 +- develop/searchindex.json | 2 +- 4 files changed, 72 insertions(+), 14 deletions(-) diff --git a/develop/deprecation_policy.html b/develop/deprecation_policy.html index 7aa9ecf784..ae4e0187a7 100644 --- a/develop/deprecation_policy.html +++ b/develop/deprecation_policy.html @@ -159,11 +159,12 @@ -

Deprecation Policy for Platform Dependencies

-

Synapse has a number of platform dependencies, including Python, Rust, -PostgreSQL and SQLite. This document outlines the policy towards which versions -we support, and when we drop support for versions in the future.

-

Policy

+

Deprecation Policy

+

Synapse has a number of platform dependencies (Python, Rust, PostgreSQL, and SQLite) +and application dependencies (Python and Rust packages). This document outlines the +policy towards which versions we support, and when we drop support for versions in the +future.

+

Platform Dependencies

Synapse follows the upstream support life cycles for Python and PostgreSQL, i.e. when a version reaches End of Life Synapse will withdraw support for that version in future releases.

@@ -177,7 +178,7 @@ people building from source should ensure they can fetch recent versions of Rust

The oldest supported version of SQLite is the version provided by Debian oldstable.

-

Context

+

Context

It is important for system admins to have a clear understanding of the platform requirements of Synapse and its deprecation policies so that they can effectively plan upgrading their infrastructure ahead of time. This is @@ -197,6 +198,34 @@ the ecosystem.

release"; bugfixes are published for the latest minor release only. We chose to track Debian's oldstable as this is relatively conservative, predictably updated and is consistent with the .deb packages released by Matrix.org.

+

Application dependencies

+

For application-level Python dependencies, we often specify loose version constraints +(ex. >=X.Y.Z) to be forwards compatible with any new versions. Upper bounds (<A.B.C) +are only added when necessary to prevent known incompatibilities.

+

When selecting a minimum version, while we are mindful of the impact on downstream +package maintainers, our primary focus is on the maintainability and progress of Synapse +itself.

+

For developers, a Python dependency version can be considered a "no-brainer" upgrade once it is +available in both the latest Debian Stable and +Ubuntu LTS repositories. No need to burden yourself with +extra scrutiny or consideration at this point.

+

We aggressively update Rust dependencies. Since these are statically linked and managed +entirely by cargo during build, they can pose no ongoing maintenance burden on others. +This allows us to freely upgrade to leverage the latest ecosystem advancements assuming +they don't have their own system-level dependencies.

+

Context

+

Because Python dependencies can easily be managed in a virtual environment, we are less +concerned about the criteria for selecting minimum versions. The only thing of concern +is making sure we're not making it unnecessarily difficult for downstream package +maintainers. Generally, this just means avoiding the bleeding edge for a few months.

+

The situation for Rust dependencies is fundamentally different. For packagers, the +concerns around Python dependency versions do not apply. The cargo tool handles +downloading and building all libraries to satisfy dependencies, and these libraries are +statically linked into the final binary. This means that from a packager's perspective, +the Rust dependency versions are an internal build detail, not a runtime dependency to +be managed on the target system. Consequently, we have even greater flexibility to +upgrade Rust dependencies as needed for the project. Some distros (e.g. Fedora) do +package Rust libraries, but this appears to be the outlier rather than the norm.

diff --git a/develop/print.html b/develop/print.html index 917a089bb6..f530aa3d98 100644 --- a/develop/print.html +++ b/develop/print.html @@ -20589,11 +20589,12 @@ table. Each subject can have only one.

Overview

Stats correspond to the present values. Current rows contain the most up-to-date statistics for a room. Each subject can only have one entry.

-

Deprecation Policy for Platform Dependencies

-

Synapse has a number of platform dependencies, including Python, Rust, -PostgreSQL and SQLite. This document outlines the policy towards which versions -we support, and when we drop support for versions in the future.

-

Policy

+

Deprecation Policy

+

Synapse has a number of platform dependencies (Python, Rust, PostgreSQL, and SQLite) +and application dependencies (Python and Rust packages). This document outlines the +policy towards which versions we support, and when we drop support for versions in the +future.

+

Platform Dependencies

Synapse follows the upstream support life cycles for Python and PostgreSQL, i.e. when a version reaches End of Life Synapse will withdraw support for that version in future releases.

@@ -20607,7 +20608,7 @@ people building from source should ensure they can fetch recent versions of Rust

The oldest supported version of SQLite is the version provided by Debian oldstable.

-

Context

+

Context

It is important for system admins to have a clear understanding of the platform requirements of Synapse and its deprecation policies so that they can effectively plan upgrading their infrastructure ahead of time. This is @@ -20627,6 +20628,34 @@ the ecosystem.

release"; bugfixes are published for the latest minor release only. We chose to track Debian's oldstable as this is relatively conservative, predictably updated and is consistent with the .deb packages released by Matrix.org.

+

Application dependencies

+

For application-level Python dependencies, we often specify loose version constraints +(ex. >=X.Y.Z) to be forwards compatible with any new versions. Upper bounds (<A.B.C) +are only added when necessary to prevent known incompatibilities.

+

When selecting a minimum version, while we are mindful of the impact on downstream +package maintainers, our primary focus is on the maintainability and progress of Synapse +itself.

+

For developers, a Python dependency version can be considered a "no-brainer" upgrade once it is +available in both the latest Debian Stable and +Ubuntu LTS repositories. No need to burden yourself with +extra scrutiny or consideration at this point.

+

We aggressively update Rust dependencies. Since these are statically linked and managed +entirely by cargo during build, they can pose no ongoing maintenance burden on others. +This allows us to freely upgrade to leverage the latest ecosystem advancements assuming +they don't have their own system-level dependencies.

+

Context

+

Because Python dependencies can easily be managed in a virtual environment, we are less +concerned about the criteria for selecting minimum versions. The only thing of concern +is making sure we're not making it unnecessarily difficult for downstream package +maintainers. Generally, this just means avoiding the bleeding edge for a few months.

+

The situation for Rust dependencies is fundamentally different. For packagers, the +concerns around Python dependency versions do not apply. The cargo tool handles +downloading and building all libraries to satisfy dependencies, and these libraries are +statically linked into the final binary. This means that from a packager's perspective, +the Rust dependency versions are an internal build detail, not a runtime dependency to +be managed on the target system. Consequently, we have even greater flexibility to +upgrade Rust dependencies as needed for the project. Some distros (e.g. Fedora) do +package Rust libraries, but this appears to be the outlier rather than the norm.

Summary of performance impact of running on resource constrained devices such as SBCs

I've been running my homeserver on a cubietruck at home now for some time and am often replying to statements like "you need loads of ram to join large rooms" with "it works fine for me". I thought it might be useful to curate a summary of the issues you're likely to run into to help as a scaling-down guide, maybe highlight these for development work or end up as documentation. It seems that once you get up to about 4x1.5GHz arm64 4GiB these issues are no longer a problem.