UPGRADE.rst 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  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. If synapse was installed in a virtualenv then active that virtualenv before
  7. upgrading. If synapse is installed in a virtualenv in ``~/.synapse/`` then run:
  8. .. code:: bash
  9. source ~/.synapse/bin/activate
  10. If synapse was installed using pip then upgrade to the latest version by
  11. running:
  12. .. code:: bash
  13. pip install --upgrade --process-dependency-links https://github.com/matrix-org/synapse/tarball/master
  14. If synapse was installed using git then upgrade to the latest version by
  15. running:
  16. .. code:: bash
  17. # Pull the latest version of the master branch.
  18. git pull
  19. # Update the versions of synapse's python dependencies.
  20. python synapse/python_dependencies.py | xargs -n1 pip install
  21. Upgrading to v0.15.0
  22. ====================
  23. If you want to use the new URL previewing API (/_matrix/media/r0/preview_url)
  24. then you have to explicitly enable it in the config and update your dependencies
  25. dependencies. See README.rst for details.
  26. Upgrading to v0.11.0
  27. ====================
  28. This release includes the option to send anonymous usage stats to matrix.org,
  29. and requires that administrators explictly opt in or out by setting the
  30. ``report_stats`` option to either ``true`` or ``false``.
  31. We would really appreciate it if you could help our project out by reporting
  32. anonymized usage statistics from your homeserver. Only very basic aggregate
  33. data (e.g. number of users) will be reported, but it helps us to track the
  34. growth of the Matrix community, and helps us to make Matrix a success, as well
  35. as to convince other networks that they should peer with us.
  36. Upgrading to v0.9.0
  37. ===================
  38. Application services have had a breaking API change in this version.
  39. They can no longer register themselves with a home server using the AS HTTP API. This
  40. decision was made because a compromised application service with free reign to register
  41. any regex in effect grants full read/write access to the home server if a regex of ``.*``
  42. is used. An attack where a compromised AS re-registers itself with ``.*`` was deemed too
  43. big of a security risk to ignore, and so the ability to register with the HS remotely has
  44. been removed.
  45. It has been replaced by specifying a list of application service registrations in
  46. ``homeserver.yaml``::
  47. app_service_config_files: ["registration-01.yaml", "registration-02.yaml"]
  48. Where ``registration-01.yaml`` looks like::
  49. url: <String> # e.g. "https://my.application.service.com"
  50. as_token: <String>
  51. hs_token: <String>
  52. sender_localpart: <String> # This is a new field which denotes the user_id localpart when using the AS token
  53. namespaces:
  54. users:
  55. - exclusive: <Boolean>
  56. regex: <String> # e.g. "@prefix_.*"
  57. aliases:
  58. - exclusive: <Boolean>
  59. regex: <String>
  60. rooms:
  61. - exclusive: <Boolean>
  62. regex: <String>
  63. Upgrading to v0.8.0
  64. ===================
  65. Servers which use captchas will need to add their public key to::
  66. static/client/register/register_config.js
  67. window.matrixRegistrationConfig = {
  68. recaptcha_public_key: "YOUR_PUBLIC_KEY"
  69. };
  70. This is required in order to support registration fallback (typically used on
  71. mobile devices).
  72. Upgrading to v0.7.0
  73. ===================
  74. New dependencies are:
  75. - pydenticon
  76. - simplejson
  77. - syutil
  78. - matrix-angular-sdk
  79. To pull in these dependencies in a virtual env, run::
  80. python synapse/python_dependencies.py | xargs -n 1 pip install
  81. Upgrading to v0.6.0
  82. ===================
  83. To pull in new dependencies, run::
  84. python setup.py develop --user
  85. This update includes a change to the database schema. To upgrade you first need
  86. to upgrade the database by running::
  87. python scripts/upgrade_db_to_v0.6.0.py <db> <server_name> <signing_key>
  88. Where `<db>` is the location of the database, `<server_name>` is the
  89. server name as specified in the synapse configuration, and `<signing_key>` is
  90. the location of the signing key as specified in the synapse configuration.
  91. This may take some time to complete. Failures of signatures and content hashes
  92. can safely be ignored.
  93. Upgrading to v0.5.1
  94. ===================
  95. Depending on precisely when you installed v0.5.0 you may have ended up with
  96. a stale release of the reference matrix webclient installed as a python module.
  97. To uninstall it and ensure you are depending on the latest module, please run::
  98. $ pip uninstall syweb
  99. Upgrading to v0.5.0
  100. ===================
  101. The webclient has been split out into a seperate repository/pacakage in this
  102. release. Before you restart your homeserver you will need to pull in the
  103. webclient package by running::
  104. python setup.py develop --user
  105. This release completely changes the database schema and so requires upgrading
  106. it before starting the new version of the homeserver.
  107. The script "database-prepare-for-0.5.0.sh" should be used to upgrade the
  108. database. This will save all user information, such as logins and profiles,
  109. but will otherwise purge the database. This includes messages, which
  110. rooms the home server was a member of and room alias mappings.
  111. If you would like to keep your history, please take a copy of your database
  112. file and ask for help in #matrix:matrix.org. The upgrade process is,
  113. unfortunately, non trivial and requires human intervention to resolve any
  114. resulting conflicts during the upgrade process.
  115. Before running the command the homeserver should be first completely
  116. shutdown. To run it, simply specify the location of the database, e.g.:
  117. ./scripts/database-prepare-for-0.5.0.sh "homeserver.db"
  118. Once this has successfully completed it will be safe to restart the
  119. homeserver. You may notice that the homeserver takes a few seconds longer to
  120. restart than usual as it reinitializes the database.
  121. On startup of the new version, users can either rejoin remote rooms using room
  122. aliases or by being reinvited. Alternatively, if any other homeserver sends a
  123. message to a room that the homeserver was previously in the local HS will
  124. automatically rejoin the room.
  125. Upgrading to v0.4.0
  126. ===================
  127. This release needs an updated syutil version. Run::
  128. python setup.py develop
  129. You will also need to upgrade your configuration as the signing key format has
  130. changed. Run::
  131. python -m synapse.app.homeserver --config-path <CONFIG> --generate-config
  132. Upgrading to v0.3.0
  133. ===================
  134. This registration API now closely matches the login API. This introduces a bit
  135. more backwards and forwards between the HS and the client, but this improves
  136. the overall flexibility of the API. You can now GET on /register to retrieve a list
  137. of valid registration flows. Upon choosing one, they are submitted in the same
  138. way as login, e.g::
  139. {
  140. type: m.login.password,
  141. user: foo,
  142. password: bar
  143. }
  144. The default HS supports 2 flows, with and without Identity Server email
  145. authentication. Enabling captcha on the HS will add in an extra step to all
  146. flows: ``m.login.recaptcha`` which must be completed before you can transition
  147. to the next stage. There is a new login type: ``m.login.email.identity`` which
  148. contains the ``threepidCreds`` key which were previously sent in the original
  149. register request. For more information on this, see the specification.
  150. Web Client
  151. ----------
  152. The VoIP specification has changed between v0.2.0 and v0.3.0. Users should
  153. refresh any browser tabs to get the latest web client code. Users on
  154. v0.2.0 of the web client will not be able to call those on v0.3.0 and
  155. vice versa.
  156. Upgrading to v0.2.0
  157. ===================
  158. The home server now requires setting up of SSL config before it can run. To
  159. automatically generate default config use::
  160. $ python synapse/app/homeserver.py \
  161. --server-name machine.my.domain.name \
  162. --bind-port 8448 \
  163. --config-path homeserver.config \
  164. --generate-config
  165. This config can be edited if desired, for example to specify a different SSL
  166. certificate to use. Once done you can run the home server using::
  167. $ python synapse/app/homeserver.py --config-path homeserver.config
  168. See the README.rst for more information.
  169. Also note that some config options have been renamed, including:
  170. - "host" to "server-name"
  171. - "database" to "database-path"
  172. - "port" to "bind-port" and "unsecure-port"
  173. Upgrading to v0.0.1
  174. ===================
  175. This release completely changes the database schema and so requires upgrading
  176. it before starting the new version of the homeserver.
  177. The script "database-prepare-for-0.0.1.sh" should be used to upgrade the
  178. database. This will save all user information, such as logins and profiles,
  179. but will otherwise purge the database. This includes messages, which
  180. rooms the home server was a member of and room alias mappings.
  181. Before running the command the homeserver should be first completely
  182. shutdown. To run it, simply specify the location of the database, e.g.:
  183. ./scripts/database-prepare-for-0.0.1.sh "homeserver.db"
  184. Once this has successfully completed it will be safe to restart the
  185. homeserver. You may notice that the homeserver takes a few seconds longer to
  186. restart than usual as it reinitializes the database.
  187. On startup of the new version, users can either rejoin remote rooms using room
  188. aliases or by being reinvited. Alternatively, if any other homeserver sends a
  189. message to a room that the homeserver was previously in the local HS will
  190. automatically rejoin the room.