1
0

UPGRADE.rst 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. Upgrading Synapse
  2. =================
  3. Before upgrading check if any special steps are required to upgrade from the
  4. what you currently have installed to current version of synapse. The extra
  5. instructions that may be required are listed later in this document.
  6. 1. If synapse was installed in a virtualenv then activate that virtualenv before
  7. upgrading. If synapse is installed in a virtualenv in ``~/synapse/env`` then
  8. run:
  9. .. code:: bash
  10. source ~/synapse/env/bin/activate
  11. 2. If synapse was installed using pip then upgrade to the latest version by
  12. running:
  13. .. code:: bash
  14. pip install --upgrade matrix-synapse[all]
  15. # restart synapse
  16. synctl restart
  17. If synapse was installed using git then upgrade to the latest version by
  18. running:
  19. .. code:: bash
  20. # Pull the latest version of the master branch.
  21. git pull
  22. # Update synapse and its python dependencies.
  23. pip install --upgrade .[all]
  24. # restart synapse
  25. ./synctl restart
  26. To check whether your update was successful, you can check the Server header
  27. returned by the Client-Server API:
  28. .. code:: bash
  29. # replace <host.name> with the hostname of your synapse homeserver.
  30. # You may need to specify a port (eg, :8448) if your server is not
  31. # configured on port 443.
  32. curl -kv https://<host.name>/_matrix/client/versions 2>&1 | grep "Server:"
  33. Upgrading to v0.99.0
  34. ====================
  35. Please be aware that, before Synapse v1.0 is released around March 2019, you
  36. will need to replace any self-signed certificates with those verified by a
  37. root CA. Information on how to do so can be found at `the ACME docs
  38. <docs/ACME.md>`_.
  39. For more information on configuring TLS certificates see the `FAQ <docs/MSC1711_certificates_FAQ.md>`_.
  40. Upgrading to v0.34.0
  41. ====================
  42. 1. This release is the first to fully support Python 3. Synapse will now run on
  43. Python versions 3.5, or 3.6 (as well as 2.7). We recommend switching to
  44. Python 3, as it has been shown to give performance improvements.
  45. For users who have installed Synapse into a virtualenv, we recommend doing
  46. this by creating a new virtualenv. For example::
  47. virtualenv -p python3 ~/synapse/env3
  48. source ~/synapse/env3/bin/activate
  49. pip install matrix-synapse
  50. You can then start synapse as normal, having activated the new virtualenv::
  51. cd ~/synapse
  52. source env3/bin/activate
  53. synctl start
  54. Users who have installed from distribution packages should see the relevant
  55. package documentation. See below for notes on Debian packages.
  56. * When upgrading to Python 3, you **must** make sure that your log files are
  57. configured as UTF-8, by adding ``encoding: utf8`` to the
  58. ``RotatingFileHandler`` configuration (if you have one) in your
  59. ``<server>.log.config`` file. For example, if your ``log.config`` file
  60. contains::
  61. handlers:
  62. file:
  63. class: logging.handlers.RotatingFileHandler
  64. formatter: precise
  65. filename: homeserver.log
  66. maxBytes: 104857600
  67. backupCount: 10
  68. filters: [context]
  69. console:
  70. class: logging.StreamHandler
  71. formatter: precise
  72. filters: [context]
  73. Then you should update this to be::
  74. handlers:
  75. file:
  76. class: logging.handlers.RotatingFileHandler
  77. formatter: precise
  78. filename: homeserver.log
  79. maxBytes: 104857600
  80. backupCount: 10
  81. filters: [context]
  82. encoding: utf8
  83. console:
  84. class: logging.StreamHandler
  85. formatter: precise
  86. filters: [context]
  87. There is no need to revert this change if downgrading to Python 2.
  88. We are also making available Debian packages which will run Synapse on
  89. Python 3. You can switch to these packages with ``apt-get install
  90. matrix-synapse-py3``, however, please read `debian/NEWS
  91. <https://github.com/matrix-org/synapse/blob/release-v0.34.0/debian/NEWS>`_
  92. before doing so. The existing ``matrix-synapse`` packages will continue to
  93. use Python 2 for the time being.
  94. 2. This release removes the ``riot.im`` from the default list of trusted
  95. identity servers.
  96. If ``riot.im`` is in your homeserver's list of
  97. ``trusted_third_party_id_servers``, you should remove it. It was added in
  98. case a hypothetical future identity server was put there. If you don't
  99. remove it, users may be unable to deactivate their accounts.
  100. 3. This release no longer installs the (unmaintained) Matrix Console web client
  101. as part of the default installation. It is possible to re-enable it by
  102. installing it separately and setting the ``web_client_location`` config
  103. option, but please consider switching to another client.
  104. Upgrading to v0.33.7
  105. ====================
  106. This release removes the example email notification templates from
  107. ``res/templates`` (they are now internal to the python package). This should
  108. only affect you if you (a) deploy your Synapse instance from a git checkout or
  109. a github snapshot URL, and (b) have email notifications enabled.
  110. If you have email notifications enabled, you should ensure that
  111. ``email.template_dir`` is either configured to point at a directory where you
  112. have installed customised templates, or leave it unset to use the default
  113. templates.
  114. Upgrading to v0.27.3
  115. ====================
  116. This release expands the anonymous usage stats sent if the opt-in
  117. ``report_stats`` configuration is set to ``true``. We now capture RSS memory
  118. and cpu use at a very coarse level. This requires administrators to install
  119. the optional ``psutil`` python module.
  120. We would appreciate it if you could assist by ensuring this module is available
  121. and ``report_stats`` is enabled. This will let us see if performance changes to
  122. synapse are having an impact to the general community.
  123. Upgrading to v0.15.0
  124. ====================
  125. If you want to use the new URL previewing API (/_matrix/media/r0/preview_url)
  126. then you have to explicitly enable it in the config and update your dependencies
  127. dependencies. See README.rst for details.
  128. Upgrading to v0.11.0
  129. ====================
  130. This release includes the option to send anonymous usage stats to matrix.org,
  131. and requires that administrators explictly opt in or out by setting the
  132. ``report_stats`` option to either ``true`` or ``false``.
  133. We would really appreciate it if you could help our project out by reporting
  134. anonymized usage statistics from your homeserver. Only very basic aggregate
  135. data (e.g. number of users) will be reported, but it helps us to track the
  136. growth of the Matrix community, and helps us to make Matrix a success, as well
  137. as to convince other networks that they should peer with us.
  138. Upgrading to v0.9.0
  139. ===================
  140. Application services have had a breaking API change in this version.
  141. They can no longer register themselves with a home server using the AS HTTP API. This
  142. decision was made because a compromised application service with free reign to register
  143. any regex in effect grants full read/write access to the home server if a regex of ``.*``
  144. is used. An attack where a compromised AS re-registers itself with ``.*`` was deemed too
  145. big of a security risk to ignore, and so the ability to register with the HS remotely has
  146. been removed.
  147. It has been replaced by specifying a list of application service registrations in
  148. ``homeserver.yaml``::
  149. app_service_config_files: ["registration-01.yaml", "registration-02.yaml"]
  150. Where ``registration-01.yaml`` looks like::
  151. url: <String> # e.g. "https://my.application.service.com"
  152. as_token: <String>
  153. hs_token: <String>
  154. sender_localpart: <String> # This is a new field which denotes the user_id localpart when using the AS token
  155. namespaces:
  156. users:
  157. - exclusive: <Boolean>
  158. regex: <String> # e.g. "@prefix_.*"
  159. aliases:
  160. - exclusive: <Boolean>
  161. regex: <String>
  162. rooms:
  163. - exclusive: <Boolean>
  164. regex: <String>
  165. Upgrading to v0.8.0
  166. ===================
  167. Servers which use captchas will need to add their public key to::
  168. static/client/register/register_config.js
  169. window.matrixRegistrationConfig = {
  170. recaptcha_public_key: "YOUR_PUBLIC_KEY"
  171. };
  172. This is required in order to support registration fallback (typically used on
  173. mobile devices).
  174. Upgrading to v0.7.0
  175. ===================
  176. New dependencies are:
  177. - pydenticon
  178. - simplejson
  179. - syutil
  180. - matrix-angular-sdk
  181. To pull in these dependencies in a virtual env, run::
  182. python synapse/python_dependencies.py | xargs -n 1 pip install
  183. Upgrading to v0.6.0
  184. ===================
  185. To pull in new dependencies, run::
  186. python setup.py develop --user
  187. This update includes a change to the database schema. To upgrade you first need
  188. to upgrade the database by running::
  189. python scripts/upgrade_db_to_v0.6.0.py <db> <server_name> <signing_key>
  190. Where `<db>` is the location of the database, `<server_name>` is the
  191. server name as specified in the synapse configuration, and `<signing_key>` is
  192. the location of the signing key as specified in the synapse configuration.
  193. This may take some time to complete. Failures of signatures and content hashes
  194. can safely be ignored.
  195. Upgrading to v0.5.1
  196. ===================
  197. Depending on precisely when you installed v0.5.0 you may have ended up with
  198. a stale release of the reference matrix webclient installed as a python module.
  199. To uninstall it and ensure you are depending on the latest module, please run::
  200. $ pip uninstall syweb
  201. Upgrading to v0.5.0
  202. ===================
  203. The webclient has been split out into a seperate repository/pacakage in this
  204. release. Before you restart your homeserver you will need to pull in the
  205. webclient package by running::
  206. python setup.py develop --user
  207. This release completely changes the database schema and so requires upgrading
  208. it before starting the new version of the homeserver.
  209. The script "database-prepare-for-0.5.0.sh" should be used to upgrade the
  210. database. This will save all user information, such as logins and profiles,
  211. but will otherwise purge the database. This includes messages, which
  212. rooms the home server was a member of and room alias mappings.
  213. If you would like to keep your history, please take a copy of your database
  214. file and ask for help in #matrix:matrix.org. The upgrade process is,
  215. unfortunately, non trivial and requires human intervention to resolve any
  216. resulting conflicts during the upgrade process.
  217. Before running the command the homeserver should be first completely
  218. shutdown. To run it, simply specify the location of the database, e.g.:
  219. ./scripts/database-prepare-for-0.5.0.sh "homeserver.db"
  220. Once this has successfully completed it will be safe to restart the
  221. homeserver. You may notice that the homeserver takes a few seconds longer to
  222. restart than usual as it reinitializes the database.
  223. On startup of the new version, users can either rejoin remote rooms using room
  224. aliases or by being reinvited. Alternatively, if any other homeserver sends a
  225. message to a room that the homeserver was previously in the local HS will
  226. automatically rejoin the room.
  227. Upgrading to v0.4.0
  228. ===================
  229. This release needs an updated syutil version. Run::
  230. python setup.py develop
  231. You will also need to upgrade your configuration as the signing key format has
  232. changed. Run::
  233. python -m synapse.app.homeserver --config-path <CONFIG> --generate-config
  234. Upgrading to v0.3.0
  235. ===================
  236. This registration API now closely matches the login API. This introduces a bit
  237. more backwards and forwards between the HS and the client, but this improves
  238. the overall flexibility of the API. You can now GET on /register to retrieve a list
  239. of valid registration flows. Upon choosing one, they are submitted in the same
  240. way as login, e.g::
  241. {
  242. type: m.login.password,
  243. user: foo,
  244. password: bar
  245. }
  246. The default HS supports 2 flows, with and without Identity Server email
  247. authentication. Enabling captcha on the HS will add in an extra step to all
  248. flows: ``m.login.recaptcha`` which must be completed before you can transition
  249. to the next stage. There is a new login type: ``m.login.email.identity`` which
  250. contains the ``threepidCreds`` key which were previously sent in the original
  251. register request. For more information on this, see the specification.
  252. Web Client
  253. ----------
  254. The VoIP specification has changed between v0.2.0 and v0.3.0. Users should
  255. refresh any browser tabs to get the latest web client code. Users on
  256. v0.2.0 of the web client will not be able to call those on v0.3.0 and
  257. vice versa.
  258. Upgrading to v0.2.0
  259. ===================
  260. The home server now requires setting up of SSL config before it can run. To
  261. automatically generate default config use::
  262. $ python synapse/app/homeserver.py \
  263. --server-name machine.my.domain.name \
  264. --bind-port 8448 \
  265. --config-path homeserver.config \
  266. --generate-config
  267. This config can be edited if desired, for example to specify a different SSL
  268. certificate to use. Once done you can run the home server using::
  269. $ python synapse/app/homeserver.py --config-path homeserver.config
  270. See the README.rst for more information.
  271. Also note that some config options have been renamed, including:
  272. - "host" to "server-name"
  273. - "database" to "database-path"
  274. - "port" to "bind-port" and "unsecure-port"
  275. Upgrading to v0.0.1
  276. ===================
  277. This release completely changes the database schema and so requires upgrading
  278. it before starting the new version of the homeserver.
  279. The script "database-prepare-for-0.0.1.sh" should be used to upgrade the
  280. database. This will save all user information, such as logins and profiles,
  281. but will otherwise purge the database. This includes messages, which
  282. rooms the home server was a member of and room alias mappings.
  283. Before running the command the homeserver should be first completely
  284. shutdown. To run it, simply specify the location of the database, e.g.:
  285. ./scripts/database-prepare-for-0.0.1.sh "homeserver.db"
  286. Once this has successfully completed it will be safe to restart the
  287. homeserver. You may notice that the homeserver takes a few seconds longer to
  288. restart than usual as it reinitializes the database.
  289. On startup of the new version, users can either rejoin remote rooms using room
  290. aliases or by being reinvited. Alternatively, if any other homeserver sends a
  291. message to a room that the homeserver was previously in the local HS will
  292. automatically rejoin the room.