diff --git a/latest/admin_api/client_server_api_extensions.html b/latest/admin_api/client_server_api_extensions.html index c28f6af4ca..940761f7ce 100644 --- a/latest/admin_api/client_server_api_extensions.html +++ b/latest/admin_api/client_server_api_extensions.html @@ -175,7 +175,38 @@ account data on the admin's user account.

To receive soft failed events in APIs like /sync and /messages, set return_soft_failed_events to true in the admin client config. When false, the normal behaviour of these endpoints is to exclude soft failed events.

+

Note: If the policy server flagged the event as spam and that caused soft failure, that will be indicated +in the event's unsigned content like so:

+
{
+  "type": "m.room.message",
+  "other": "event_fields_go_here",
+  "unsigned": {
+    "io.element.synapse.soft_failed": true,
+    "io.element.synapse.policy_server_spammy": true
+  }
+}
+

Default: false

+

See events marked spammy by policy servers

+

Learn more about policy servers from MSC4284.

+

Similar to return_soft_failed_events, clients logged in with admin accounts can see events which were +flagged by the policy server as spammy (and thus soft failed) by setting return_policy_server_spammy_events +to true.

+

return_policy_server_spammy_events may be true while return_soft_failed_events is false to only see +policy server-flagged events. When return_soft_failed_events is true however, return_policy_server_spammy_events +is always true.

+

Events which were flagged by the policy will be flagged as io.element.synapse.policy_server_spammy in the +event's unsigned content, like so:

+
{
+  "type": "m.room.message",
+  "other": "event_fields_go_here",
+  "unsigned": {
+    "io.element.synapse.soft_failed": true,
+    "io.element.synapse.policy_server_spammy": true
+  }
+}
+
+

Default: true if return_soft_failed_events is true, otherwise false

diff --git a/latest/print.html b/latest/print.html index c1431df5f5..577d09c033 100644 --- a/latest/print.html +++ b/latest/print.html @@ -1149,8 +1149,20 @@ this is necessary is in corporate environments behind a DMZ (demilitarized zone) Synapse supports routing outbound HTTP(S) requests via a proxy. Only HTTP(S) proxy is supported, not SOCKS proxy or anything else.

Configure

-

The http_proxy, https_proxy, no_proxy environment variables are used to -specify proxy settings. The environment variable is not case sensitive.

+

The proxy settings can be configured in the homeserver configuration file via +http_proxy, +https_proxy, and +no_proxy_hosts.

+

homeserver.yaml example:

+
http_proxy: http://USERNAME:PASSWORD@10.0.1.1:8080/
+https_proxy: http://USERNAME:PASSWORD@proxy.example.com:8080/
+no_proxy_hosts:
+  - master.hostname.example.com
+  - 10.1.0.0/16
+  - 172.30.0.0/16
+
+

The proxy settings can also be configured via the http_proxy, https_proxy, +no_proxy environment variables. The environment variable is not case sensitive.