From 7c5dd6ffb85f208632f7a2018a922b5ef2083c18 Mon Sep 17 00:00:00 2001 From: anoadragon453 Date: Tue, 22 Mar 2022 16:30:53 +0000 Subject: deploy: 6b26536a52f77aa5573b4d2afedae448fac31b7c --- latest/print.html | 299 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 245 insertions(+), 54 deletions(-) (limited to 'latest/print.html') diff --git a/latest/print.html b/latest/print.html index 038329652d..9558290e01 100644 --- a/latest/print.html +++ b/latest/print.html @@ -101,7 +101,7 @@ @@ -795,9 +795,9 @@ space on disk after porting to Postgres.

Firstly, shut down the currently running synapse server and copy its database file (typically homeserver.db) to another location. Once the copy is complete, restart synapse. For instance:

-
./synctl stop
+
synctl stop
 cp homeserver.db homeserver.db.snapshot
-./synctl start
+synctl start
 

 
Copy the old config file into a new config file:

 
cp homeserver.yaml homeserver-postgres.yaml
@@ -820,10 +820,10 @@ run:

 

 
Once that has completed, change the synapse config to point at the
 PostgreSQL database configuration file homeserver-postgres.yaml:

-
./synctl stop
+
synctl stop
 mv homeserver.yaml homeserver-old-sqlite.yaml
 mv homeserver-postgres.yaml homeserver.yaml
-./synctl start
+synctl start
 

 
Synapse should now be running against PostgreSQL.

 
Troubleshooting

@@ -1374,8 +1374,9 @@ turn_allow_guests: True
 
After updating the homeserver configuration, you must restart synapse:

 
    
 
  • If you use synctl:
-
    cd /where/you/run/synapse
-./synctl restart
+
    # Depending on how Synapse is installed, synctl may already be on
+# your PATH. If not, you may need to activate a virtual environment.
+synctl restart
 
    
 
    • 
 
  • If you use systemd:
@@ -1603,7 +1604,7 @@ pip install --upgrade .
 
    • 
 
  • 
 
    Restart Synapse:
    
-
    ./synctl restart
+
    synctl restart
 
    
 
    • 
 
@@ -1638,6 +1639,37 @@ dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
 

 
 
+
Upgrading to v1.56.0

+
Groups/communities feature has been deprecated

+
The non-standard groups/communities feature in Synapse has been deprecated and will
+be disabled by default in Synapse v1.58.0.

+
You can test disabling it by adding the following to your homeserver configuration:

+
experimental_features:
+  groups_enabled: false
+

+
Upgrading to v1.55.0

+
synctl script has been moved

+
The synctl script
+has been made an
+entry point
+and no longer exists at the root of Synapse's source tree. If you wish to use
+synctl to manage your homeserver, you should invoke synctl directly, e.g. 
+synctl start instead of ./synctl start or /path/to/synctl start. 

+
You will need to ensure synctl is on your PATH.

+
    
+
  • This is automatically the case when using
+Debian packages or
+docker images
+provided by Matrix.org.
    • 
+
  • When installing from a wheel, sdist, or PyPI, a synctl executable is added 
+to your Python installation's bin. This should be on your PATH
+automatically, though you might need to activate a virtual environment
+depending on how you installed Synapse.
    • 
+

+
Compatibility dropped for Mjolnir 1.3.1 and earlier

+
Synapse v1.55.0 drops support for Mjolnir 1.3.1 and earlier.
+If you use the Mjolnir module to moderate your homeserver,
+please upgrade Mjolnir to version 1.3.2 or later before upgrading Synapse.

 
Upgrading to v1.54.0

 
Legacy structured logging configuration removal

 
This release removes support for the structured: true logging configuration
@@ -2904,7 +2936,8 @@ release of Synapse.

 
Running a demo federation of Synapses

 
If you want to get up and running quickly with a trio of homeservers in a
 private federation, there is a script in the demo directory. This is mainly
-useful just for development purposes. See demo/README.

+useful just for development purposes. See
+demo scripts.

 
Configuration

 
This section contains information on tweaking Synapse via the various options in the configuration file. A configuration
 file should have been generated when you installed Synapse.

@@ -4865,8 +4898,14 @@ saml2_config:
 #
 #             localpart_template: Jinja2 template for the localpart of the MXID.
 #                 If this is not set, the user will be prompted to choose their
-#                 own username (see 'sso_auth_account_details.html' in the 'sso'
-#                 section of this file).
+#                 own username (see the documentation for the
+#                 'sso_auth_account_details.html' template). This template can
+#                 use the 'localpart_from_email' filter.
+#
+#             confirm_localpart: Whether to prompt the user to validate (or
+#                 change) the generated localpart (see the documentation for the
+#                 'sso_auth_account_details.html' template), instead of
+#                 registering the account right away.
 #
 #             display_name_template: Jinja2 template for the display name to set
 #                 on first login. If unset, no displayname will be set.
@@ -5647,6 +5686,38 @@ redis:
   # Optional password if configured on the Redis instance
   #
   #password: <secret_password>
+
+
+## Background Updates ##
+
+# Background updates are database updates that are run in the background in batches.
+# The duration, minimum batch size, default batch size, whether to sleep between batches and if so, how long to
+# sleep can all be configured. This is helpful to speed up or slow down the updates.
+#
+background_updates:
+    # How long in milliseconds to run a batch of background updates for. Defaults to 100. Uncomment and set
+    # a time to change the default.
+    #
+    #background_update_duration_ms: 500
+
+    # Whether to sleep between updates. Defaults to True. Uncomment to change the default.
+    #
+    #sleep_enabled: false
+
+    # If sleeping between updates, how long in milliseconds to sleep for. Defaults to 1000. Uncomment
+    # and set a duration to change the default.
+    #
+    #sleep_duration_ms: 300
+
+    # Minimum size a batch of background updates can be. Must be greater than 0. Defaults to 1. Uncomment and
+    # set a size to change the default.
+    #
+    #min_batch_size: 10
+
+    # The batch size to use for the first iteration of a new background update. The default is 100.
+    # Uncomment and set a size to change the default.
+    #
+    #default_batch_size: 50

Logging Sample Configuration File

Below is a sample logging configuration file. This file can be tweaked to control how your @@ -5902,6 +5973,10 @@ already available as part of Jinja 2:

Turns a mxc:// URL for media content into an HTTP(S) one using the homeserver's public_baseurl configuration setting as the URL's base.

Example: message.sender_avatar_url|mxc_to_http(32,32)

+
localpart_from_email(address: str) -> str
+
+

Returns the local part of an email address (e.g. alice in alice@example.com).

+

Example: user.email_address|localpart_from_email

Email templates

Below are the templates Synapse will look for when generating the content of an email: