summary refs log tree commit diff
path: root/UPGRADE.rst
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2018-12-04 14:46:31 +0100
committerGitHub <noreply@github.com>2018-12-04 14:46:31 +0100
commita2ed0f287e8bcd647d7534da88e1e32f62a0d372 (patch)
tree6f3cc1c7e08b778cb070b177b16382bc455865da /UPGRADE.rst
parentMerge pull request #4261 from matrix-org/rav/docker/remove_log_file (diff)
parentNotes on upgrading to python3, and README updates. (diff)
downloadsynapse-a2ed0f287e8bcd647d7534da88e1e32f62a0d372.tar.xz
Merge pull request #4260 from matrix-org/rav/python3
Notes on upgrading to python3, and README updates.
Diffstat (limited to 'UPGRADE.rst')
-rw-r--r--UPGRADE.rst67
1 files changed, 63 insertions, 4 deletions
diff --git a/UPGRADE.rst b/UPGRADE.rst
index aa5473ec62..9d68a64058 100644
--- a/UPGRADE.rst
+++ b/UPGRADE.rst
@@ -51,11 +51,70 @@ returned by the Client-Server API:
 Upgrading to v0.34.0
 ====================
 
-This release removes the ``riot.im`` from the default list of trusted identity servers.
+1. This release is the first to fully support Python 3. We recommend switching
+   to Python 3, as it has been shown to give performance improvements.
+
+   For users who have installed Synapse into a virtualenv, we recommend doing
+   this by creating a new virtualenv. For example::
+
+       virtualenv -p python3 ~/synapse/env3
+       source ~/synapse/env3/bin/activate
+       pip install matrix-synapse
+
+   You can then start synapse as normal, having activated the new virtualenv::
+
+       cd ~/synapse
+       source env3/bin/activate
+       synctl start
+
+   Users who have installed from distribution packages should see the relevant
+   package documentation.
+
+   * When upgrading to Python 3, you **must** make sure that your log files are
+     configured as UTF-8, by adding ``encoding: utf8`` to the
+     ``RotatingFileHandler`` configuration (if you have one) in your
+     ``<server>.log.config`` file. For example, if your ``log.config`` file
+     contains::
+
+       handlers:
+         file:
+           class: logging.handlers.RotatingFileHandler
+           formatter: precise
+           filename: homeserver.log
+           maxBytes: 104857600
+           backupCount: 10
+           filters: [context]
+         console:
+           class: logging.StreamHandler
+           formatter: precise
+           filters: [context]
+
+     Then you should update this to be::
+
+       handlers:
+         file:
+           class: logging.handlers.RotatingFileHandler
+           formatter: precise
+           filename: homeserver.log
+           maxBytes: 104857600
+           backupCount: 10
+           filters: [context]
+           encoding: utf8
+         console:
+           class: logging.StreamHandler
+           formatter: precise
+           filters: [context]
+
+     There is no need to revert this change if downgrading to Python 2.
+
+2. This release removes the ``riot.im`` from the default list of trusted
+   identity servers.
+
+   If ``riot.im`` is in your homeserver's list of
+   ``trusted_third_party_id_servers``, you should remove it. It was added in
+   case a hypothetical future identity server was put there. If you don't
+   remove it, users may be unable to deactivate their accounts.
 
-If ``riot.im`` is in your homeserver's list of ``trusted_third_party_id_servers``,
-you should remove it. It was added in case a hypothetical future identity server was
-put there. If you don't remove it, users may be unable to deactivate their accounts.
 
 Upgrading to v0.33.7
 ====================