From dd6056eb58d896293c4ed23451f3942f08691b88 Mon Sep 17 00:00:00 2001 From: reivilibre Date: Tue, 18 Jul 2023 15:46:53 +0000 Subject: deploy: 69699a9bd11822635fcf2166f5dec2ce2365219c --- latest/print.html | 93 ++++++++++++++++++------------------------------------- 1 file changed, 30 insertions(+), 63 deletions(-) (limited to 'latest/print.html') diff --git a/latest/print.html b/latest/print.html index 300c12be4b..fb889b1adf 100644 --- a/latest/print.html +++ b/latest/print.html @@ -362,7 +362,7 @@ and mounting it to /var/synapse should be taken into consideration.

System requirements:

If building on an uncommon architecture for which pre-built wheels are @@ -1779,6 +1779,24 @@ dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb +

Upgrading to v1.88.0

+

Minimum supported Python version

+

The minimum supported Python version has been increased from v3.7 to v3.8. +You will need Python 3.8 to run Synapse v1.88.0 (due out July 18th, 2023).

+

If you use current versions of the Matrix.org-distributed Debian +packages or Docker images, no action is required.

+

Removal of worker_replication_* settings

+

As mentioned previously in Upgrading to v1.84.0, the following deprecated settings +are being removed in this release of Synapse:

+ +

Please ensure that you have migrated to using main on your shared configuration's instance_map +(or create one if necessary). This is required if you have any workers at all; +administrators of single-process (monolith) installations don't need to do anything.

+

For an illustrative example, please see Upgrading to v1.84.0 below.

Upgrading to v1.86.0

Minimum supported Rust version

The minimum supported Rust version has been increased from v1.58.1 to v1.60.0. @@ -7158,39 +7176,6 @@ giving each worker a unique worker_name.

worker_name: generic_worker1
-

worker_replication_host

-

Deprecated as of version 1.84.0. Place host under main entry on the instance_map in your shared yaml configuration instead.

-

The HTTP replication endpoint that it should talk to on the main Synapse process. -The main Synapse process defines this with a replication resource in -listeners option.

-

Example configuration:

-
worker_replication_host: 127.0.0.1
-
-
-

worker_replication_http_port

-

Deprecated as of version 1.84.0. Place port under main entry on the instance_map in your shared yaml configuration instead.

-

The HTTP replication port that it should talk to on the main Synapse process. -The main Synapse process defines this with a replication resource in -listeners option.

-

Example configuration:

-
worker_replication_http_port: 9093
-
-
-

worker_replication_http_tls

-

Deprecated as of version 1.84.0. Place tls under main entry on the instance_map in your shared yaml configuration instead.

-

Whether TLS should be used for talking to the HTTP replication port on the main -Synapse process. -The main Synapse process defines this with the tls option on its listener that -has the replication resource enabled.

-

Please note: by default, it is not safe to expose replication ports to the -public Internet, even with TLS enabled. -See worker_replication_secret.

-

Defaults to false.

-

Added in Synapse 1.72.0.

-

Example configuration:

-
worker_replication_http_tls: true
-
-

worker_listeners

A worker can handle HTTP requests. To do so, a worker_listeners option must be declared, in the same way as the listeners option @@ -10893,9 +10878,6 @@ The currently available worker applications are listed worker_replication_host and -worker_replication_http_port). If using Synapse 1.84 and newer, these are not needed if main is defined on the shared configuration instance_map

For example:

worker_app: synapse.app.generic_worker
@@ -11178,11 +11160,7 @@ stream_writers:

An example for a stream writer instance:

worker_app: synapse.app.generic_worker
-worker_name: event_persister1 
-
-# The replication listener on the main synapse process.
-worker_replication_host: 127.0.0.1
-worker_replication_http_port: 9093
+worker_name: event_persister1
 
 worker_listeners:
   - type: http
@@ -11275,10 +11253,6 @@ to a dedicated worker, the shared configuration would include:

 
worker_app: synapse.app.generic_worker
 worker_name: background_worker
 
-# The replication listener on the main synapse process.
-worker_replication_host: 127.0.0.1
-worker_replication_http_port: 9093
-
 worker_log_config: /etc/matrix-synapse/background-worker-log.yaml
 

 
Updating the User Directory

@@ -11347,10 +11321,6 @@ pusher_instances:
 
worker_app: synapse.app.pusher
 worker_name: pusher_worker1
 
-# The replication listener on the main synapse process.
-worker_replication_host: 127.0.0.1
-worker_replication_http_port: 9093
-
 worker_log_config: /etc/matrix-synapse/pusher-worker-log.yaml
 

 
synapse.app.appservice

@@ -11383,10 +11353,6 @@ federation_sender_instances:
 
worker_app: synapse.app.federation_sender
 worker_name: federation_sender1
 
-# The replication listener on the main synapse process.
-worker_replication_host: 127.0.0.1
-worker_replication_http_port: 9093
-
 worker_log_config: /etc/matrix-synapse/federation-sender-log.yaml
 

 
synapse.app.media_repository

@@ -11413,10 +11379,6 @@ expose the media resource. For example:

 
worker_app: synapse.app.media_repository
 worker_name: media_worker
 
-# The replication listener on the main synapse process.
-worker_replication_host: 127.0.0.1
-worker_replication_http_port: 9093
-
 worker_listeners:
   - type: http
     port: 8085
@@ -13910,6 +13872,11 @@ which guarantees a stable ordering. Valid values are:

 
dir - Direction of media order. Either f for forwards or b for backwards.
 Setting this value to b will reverse the above sort order. Defaults to f.

 
+
  • 
+
    not_user_type - Exclude certain user types, such as bot users, from the request.
+Can be provided multiple times. Possible values are bot, support or "empty string".
+"empty string" here means to exclude users without a type.
    
+
    • 
 
 
    Caution. The database only has indexes on the columns name and creation_ts.
 This means that if a different sort order is used (is_guest, admin,
@@ -14689,7 +14656,7 @@ being limited.
 
  • user_id - The fully qualified MXID: for example, @user:server.com. The user must
 be local.
    • 
 
-
    Check username availability
    
+
    Check username availability
    
 
    Checks to see if a username is available, and valid, for the server. See the client-server 
 API
 for more information.
    
@@ -14700,7 +14667,7 @@ for more information.
    
 
    
 
    The request and response format is the same as the
 /_matrix/client/r0/register/available API.
    
-
    Find a user based on their ID in an auth provider
    
+
    Find a user based on their ID in an auth provider
    
 
    The API is:
    
 
    GET /_synapse/admin/v1/auth_providers/$provider/users/$external_id
 
    
@@ -14724,7 +14691,7 @@ for more information.
    
 }

    Added in Synapse 1.68.0.

    -

    Find a user based on their Third Party ID (ThreePID or 3PID)

    +

    Find a user based on their Third Party ID (ThreePID or 3PID)

    The API is:

    GET /_synapse/admin/v1/threepid/$medium/users/$address
    @@ -16107,7 +16074,7 @@ anything was broken. They are slower than the unit tests but will typically catch more errors.

    The following command will let you run the integration test with the most common configuration:

    -
    $ docker run --rm -it -v /path/where/you/have/cloned/the/repository\:/src:ro -v /path/to/where/you/want/logs\:/logs matrixdotorg/sytest-synapse:buster
+
    $ docker run --rm -it -v /path/where/you/have/cloned/the/repository\:/src:ro -v /path/to/where/you/want/logs\:/logs matrixdotorg/sytest-synapse:focal
 
    
 
    (Note that the paths must be full paths! You could also write $(realpath relative/path) if needed.)
    
 
    This configuration should generally cover your needs.
    
@@ -18779,7 +18746,7 @@ the minimum required version may be bumped up to a recent Rust version, and so
 people building from source should ensure they can fetch recent versions of Rust
 (e.g. by using rustup).
    
 
    The oldest supported version of SQLite is the version
-provided by
+provided by
 Debian oldstable.
    
 
    Context
    
 
    It is important for system admins to have a clear understanding of the platform
-- 
cgit 1.5.1