From e21fcdca4f8ea0d021828641466c286a0256c908 Mon Sep 17 00:00:00 2001
From: Tulir Asokan <tulir@maunium.net>
Date: Sun, 12 Feb 2023 14:28:52 +0200
Subject: [PATCH] Add meow readme and config extension
---
README.md | 63 ++++++++++++++++++++++++++++++++++++
synapse/config/_base.pyi | 2 ++
synapse/config/homeserver.py | 2 ++
synapse/config/meow.py | 33 +++++++++++++++++++
4 files changed, 100 insertions(+)
create mode 100644 README.md
create mode 100644 synapse/config/meow.py
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..9d4829c931
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# Maunium Synapse
+This is a fork of [Synapse] to remove dumb limits and fix bugs that the
+upstream devs don't want to fix.
+
+The only official distribution is the docker image in the [GitLab container
+registry], but you can also install from source ([upstream instructions]).
+
+The master branch and `:latest` docker tag are upgraded to each upstream
+release candidate very soon after release (usually within 10 minutes†). There
+are also docker tags for each release, e.g. `:1.75.0`. If you don't want RCs,
+use the specific release tags.
+
+†If there are merge conflicts, the update may be delayed for up to a few days
+after the full release.
+
+[Synapse]: https://github.com/matrix-org/synapse
+[GitLab container registry]: https://mau.dev/maunium/synapse/container_registry
+[upstream instructions]: https://github.com/matrix-org/synapse/blob/develop/INSTALL.md#installing-from-source
+
+## List of changes
+* Default power level for room creator is 9001 instead of 100.
+* Room creator can specify a custom room ID with the `room_id` param in the
+ request body. If the room ID is already in use, it will return `M_CONFLICT`.
+* ~~URL previewer user agent includes `Bot` so Twitter previews work properly.~~
+ Upstreamed after over 2 years 🎉
+* ~~Local event creation concurrency is disabled to avoid unnecessary state
+ resolution.~~ Upstreamed after over 3 years 🎉
+* Register admin API can register invalid user IDs.
+* Docker image with jemalloc enabled by default.
+* Config option to allow specific users to send events without unnecessary
+ validation.
+* Config option to allow specific users to receive events that are usually
+ filtered away (e.g. `org.matrix.dummy_event` and `m.room.aliases`).
+* Config option to allow specific users to use timestamp massaging without
+ being appservice users.
+* Removed bad pusher URL validation.
+* webp images are thumbnailed to webp instead of jpeg to avoid losing
+ transparency.
+* Media repo `Cache-Control` header says `immutable` and 1 year for all media
+ that exists, as media IDs in Matrix are immutable.
+* Allowed sending custom data with read receipts.
+
+You can view the full list of changes on the [meow-patchset] branch.
+Additionally, historical patch sets are saved as `meow-patchset-vX` [tags].
+
+[meow-patchset]: https://mau.dev/maunium/synapse/-/compare/patchset-base...meow-patchset
+[tags]: https://mau.dev/maunium/synapse/-/tags?search=meow-patchset&sort=updated_desc
+
+## Configuration reference
+```yaml
+meow:
+ # List of users who aren't subject to unnecessary validation in the C-S API.
+ validation_override:
+ - "@you:example.com"
+ # List of users who will get org.matrix.dummy_event and m.room.aliases events down /sync
+ filter_override:
+ - "@you:example.com"
+ # Whether or not the admin API should be able to register invalid user IDs.
+ admin_api_register_invalid: true
+ # List of users who can use timestamp massaging without being appservices
+ timestamp_override:
+ - "@you:example.com"
+```
diff --git a/synapse/config/_base.pyi b/synapse/config/_base.pyi
index d9cb0da38b..c3120e6651 100644
--- a/synapse/config/_base.pyi
+++ b/synapse/config/_base.pyi
@@ -36,6 +36,7 @@ from synapse.config import ( # noqa: F401
jwt,
key,
logger,
+ meow,
metrics,
modules,
oembed,
@@ -92,6 +93,7 @@ class RootConfig:
voip: voip.VoipConfig
registration: registration.RegistrationConfig
account_validity: account_validity.AccountValidityConfig
+ meow: meow.MeowConfig
metrics: metrics.MetricsConfig
api: api.ApiConfig
appservice: appservice.AppServiceConfig
diff --git a/synapse/config/homeserver.py b/synapse/config/homeserver.py
index e36c0bd6ae..822e25f682 100644
--- a/synapse/config/homeserver.py
+++ b/synapse/config/homeserver.py
@@ -19,6 +19,7 @@
#
#
from ._base import RootConfig
+from .meow import MeowConfig
from .account_validity import AccountValidityConfig
from .api import ApiConfig
from .appservice import AppServiceConfig
@@ -65,6 +66,7 @@ from .workers import WorkerConfig
class HomeServerConfig(RootConfig):
config_classes = [
+ MeowConfig,
ModulesConfig,
ServerConfig,
RetentionConfig,
diff --git a/synapse/config/meow.py b/synapse/config/meow.py
new file mode 100644
index 0000000000..a7492bf66c
--- /dev/null
+++ b/synapse/config/meow.py
@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+# Copyright 2020 Maunium
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from ._base import Config
+
+
+class MeowConfig(Config):
+ """Meow Configuration
+ Configuration for disabling dumb limits in Synapse
+ """
+
+ section = "meow"
+
+ def read_config(self, config, **kwargs):
+ meow_config = config.get("meow", {})
+ self.validation_override = set(meow_config.get("validation_override", []))
+ self.filter_override = set(meow_config.get("filter_override", []))
+ self.timestamp_override = set(meow_config.get("timestamp_override", []))
+ self.admin_api_register_invalid = meow_config.get(
+ "admin_api_register_invalid", True
+ )
--
GitLab