From 9bbdc7c00d5391df03683bd42cea833e94277ee9 Mon Sep 17 00:00:00 2001 From: Strac Consulting Engineers Pty Ltd Date: Sat, 19 Jul 2025 11:58:35 +1000 Subject: [PATCH 01/10] Update README.rst Minor improvements. --- README.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 8974990ed15..1330af97966 100644 --- a/README.rst +++ b/README.rst @@ -8,7 +8,7 @@ Synapse is an open source `Matrix `__ homeserver implementation, written and maintained by `Element `_. `Matrix `__ is the open standard for -secure and interoperable real time communications. You can directly run +secure and interoperable real-time communications. You can directly run and manage the source code in this repository, available under an AGPL license (or alternatively under a commercial license from Element). There is no support provided by Element unless you have a @@ -23,12 +23,12 @@ ESS builds on Synapse to offer a complete Matrix-based backend including the ful `Admin Console product `_, giving admins the power to easily manage an organization-wide deployment. It includes advanced identity management, auditing, -moderation and data retention options as well as Long Term Support and +moderation and data retention options as well as Long-Term Support and SLAs. ESS can be used to support any Matrix-based frontend client. .. contents:: -🛠️ Installing and configuration +🛠️ Installation and configuration =============================== The Synapse documentation describes `how to install Synapse `_. We recommend using @@ -133,7 +133,7 @@ connect from a client: see An easy way to get started is to login or register via Element at https://app.element.io/#/login or https://app.element.io/#/register respectively. You will need to change the server you are logging into from ``matrix.org`` -and instead specify a Homeserver URL of ``https://:8448`` +and instead specify a homeserver URL of ``https://:8448`` (or just ``https://`` if you are using a reverse proxy). If you prefer to use another client, refer to our `client breakdown `_. @@ -209,10 +209,10 @@ Identity servers have the job of mapping email addresses and other 3rd Party IDs (3PIDs) to Matrix user IDs, as well as verifying the ownership of 3PIDs before creating that mapping. -**They are not where accounts or credentials are stored - these live on home -servers. Identity Servers are just for mapping 3rd party IDs to matrix IDs.** +**Identity servers do not store accounts or credentials - these are stored and managed on homeservers. +Identity Servers are just for mapping 3rd party IDs to matrix IDs.** -This process is very security-sensitive, as there is obvious risk of spam if it +This process is highly security-sensitive, as there is an obvious risk of spam if it is too easy to sign up for Matrix accounts or harvest 3PID data. In the longer term, we hope to create a decentralised system to manage it (`matrix-doc #712 `_), but in the meantime, @@ -238,9 +238,9 @@ email address. We welcome contributions to Synapse from the community! The best place to get started is our `guide for contributors `_. -This is part of our larger `documentation `_, which includes - +This is part of our broader `documentation `_, which includes information for Synapse developers as well as Synapse administrators. + Developers might be particularly interested in: * `Synapse's database schema `_, From 0bbbac5aeadf3ddc4b9e3cad87faf10d750af111 Mon Sep 17 00:00:00 2001 From: Strac Consulting Engineers Pty Ltd Date: Sat, 19 Jul 2025 12:02:13 +1000 Subject: [PATCH 02/10] Create 18700.misc Minor improvements to README. --- changelog.d/18700.misc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/18700.misc diff --git a/changelog.d/18700.misc b/changelog.d/18700.misc new file mode 100644 index 00000000000..4b1f868c84b --- /dev/null +++ b/changelog.d/18700.misc @@ -0,0 +1 @@ +Minor improvements to README. From 151967c829476f56b10eda7966e8ac7e17155711 Mon Sep 17 00:00:00 2001 From: Strac Consulting Engineers Pty Ltd Date: Sat, 19 Jul 2025 12:09:11 +1000 Subject: [PATCH 03/10] Update README.rst Matrix ID , usernames --- README.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 1330af97966..3b8be67695f 100644 --- a/README.rst +++ b/README.rst @@ -162,16 +162,15 @@ the public internet. Without it, anyone can freely register accounts on your hom This can be exploited by attackers to create spambots targeting the rest of the Matrix federation. -Your new user name will be formed partly from the ``server_name``, and partly -from a localpart you specify when you create the account. Your name will take -the form of:: +Your new Matrix ID will be formed partly from the ``server_name``, and partly +from a localpart you specify when you create the account in the form of:: @localpart:my.domain.name (pronounced "at localpart on my dot domain dot name"). As when logging in, you will need to specify a "Custom server". Specify your -desired ``localpart`` in the 'User name' box. +desired ``localpart`` in the 'Username' box. 🎯 Troubleshooting and support ============================== From f14d99bc60577f2160f2ae38c43e8f830bb5c76d Mon Sep 17 00:00:00 2001 From: Strac Consulting Engineers Pty Ltd Date: Sat, 19 Jul 2025 12:11:13 +1000 Subject: [PATCH 04/10] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 3b8be67695f..219e1e71fee 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,7 @@ ESS builds on Synapse to offer a complete Matrix-based backend including the ful giving admins the power to easily manage an organization-wide deployment. It includes advanced identity management, auditing, moderation and data retention options as well as Long-Term Support and -SLAs. ESS can be used to support any Matrix-based frontend client. +SLAs. ESS can be used to support any Matrix-compatible client. .. contents:: From 70c8d1d6eada9f72eda10e2e50c45effdaf4e40a Mon Sep 17 00:00:00 2001 From: Strac Consulting Engineers Pty Ltd Date: Sat, 19 Jul 2025 12:13:11 +1000 Subject: [PATCH 05/10] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 219e1e71fee..8e6c43944cf 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,7 @@ ESS builds on Synapse to offer a complete Matrix-based backend including the ful giving admins the power to easily manage an organization-wide deployment. It includes advanced identity management, auditing, moderation and data retention options as well as Long-Term Support and -SLAs. ESS can be used to support any Matrix-compatible client. +SLAs. ESS supports any Matrix-compatible clients. .. contents:: From 84f325e7bd4b4b35a5958ea026a59c65eb5cb852 Mon Sep 17 00:00:00 2001 From: Strac Consulting Engineers Pty Ltd Date: Sat, 19 Jul 2025 13:00:37 +1000 Subject: [PATCH 06/10] Minor improvements to comments build_rust.py Minor improvements to comments build_rust.py --- build_rust.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/build_rust.py b/build_rust.py index d2726cee265..13284202875 100644 --- a/build_rust.py +++ b/build_rust.py @@ -19,17 +19,17 @@ def build(setup_kwargs: Dict[str, Any]) -> None: # This flag is a no-op in the latest versions. Instead, we need to # specify this in the `bdist_wheel` config below. py_limited_api=True, - # We force always building in release mode, as we can't tell the - # difference between using `poetry` in development vs production. + # We always build in release mode, as we can't distinguish + # between using `poetry` in development vs production. debug=False, ) setup_kwargs.setdefault("rust_extensions", []).append(extension) setup_kwargs["zip_safe"] = False - # We lookup the minimum supported python version by looking at - # `python_requires` (e.g. ">=3.9.0,<4.0.0") and finding the first python + # We look up the minimum supported Python version with + # `python_requires` (e.g. ">=3.9.0,<4.0.0") and finding the first Python # version that matches. We then convert that into the `py_limited_api` form, - # e.g. cp39 for python 3.9. + # e.g. cp39 for Python 3.9. py_limited_api: str python_bounds = SpecifierSet(setup_kwargs["python_requires"]) for minor_version in itertools.count(start=8): From 69f6a3f87da266c90ef026e2b5ecd019193d6e78 Mon Sep 17 00:00:00 2001 From: Strac Consulting Engineers Pty Ltd Date: Sat, 19 Jul 2025 15:35:06 +1000 Subject: [PATCH 07/10] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 8e6c43944cf..4dafa7e450a 100644 --- a/README.rst +++ b/README.rst @@ -29,7 +29,7 @@ SLAs. ESS supports any Matrix-compatible clients. .. contents:: 🛠️ Installation and configuration -=============================== +================================== The Synapse documentation describes `how to install Synapse `_. We recommend using `Docker images `_ or `Debian packages from Matrix.org From e80cd6bb33e4e017fe30c3c10c64bd0ac748eaee Mon Sep 17 00:00:00 2001 From: Strac Consulting Engineers Pty Ltd Date: Wed, 23 Jul 2025 08:32:34 +1000 Subject: [PATCH 08/10] Rename 18700.misc to 18700.doc --- changelog.d/{18700.misc => 18700.doc} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename changelog.d/{18700.misc => 18700.doc} (100%) diff --git a/changelog.d/18700.misc b/changelog.d/18700.doc similarity index 100% rename from changelog.d/18700.misc rename to changelog.d/18700.doc From 8bb4cd6bfdd1c8557803fc93855f433b20cd347f Mon Sep 17 00:00:00 2001 From: Strac Consulting Engineers Pty Ltd Date: Fri, 25 Jul 2025 18:06:57 +1000 Subject: [PATCH 09/10] Update README.rst Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 4dafa7e450a..d4c1144195c 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,7 @@ ESS builds on Synapse to offer a complete Matrix-based backend including the ful giving admins the power to easily manage an organization-wide deployment. It includes advanced identity management, auditing, moderation and data retention options as well as Long-Term Support and -SLAs. ESS supports any Matrix-compatible clients. +SLAs. ESS supports any Matrix-compatible client. .. contents:: From 62479f9affde6dd81c89afe5f7fe6fd06841a126 Mon Sep 17 00:00:00 2001 From: Strac Consulting Engineers Pty Ltd Date: Fri, 25 Jul 2025 18:07:05 +1000 Subject: [PATCH 10/10] Update README.rst Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index d4c1144195c..92854f631cb 100644 --- a/README.rst +++ b/README.rst @@ -209,7 +209,7 @@ IDs (3PIDs) to Matrix user IDs, as well as verifying the ownership of 3PIDs before creating that mapping. **Identity servers do not store accounts or credentials - these are stored and managed on homeservers. -Identity Servers are just for mapping 3rd party IDs to matrix IDs.** +Identity Servers are just for mapping 3rd Party IDs to Matrix IDs.** This process is highly security-sensitive, as there is an obvious risk of spam if it is too easy to sign up for Matrix accounts or harvest 3PID data. In the longer