UPGRADE.rst 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900
  1. Upgrading Synapse
  2. =================
  3. Before upgrading check if any special steps are required to upgrade from the
  4. version you currently have installed to the current version of Synapse. The extra
  5. instructions that may be required are listed later in this document.
  6. * If Synapse was installed using `prebuilt packages
  7. <INSTALL.md#prebuilt-packages>`_, you will need to follow the normal process
  8. for upgrading those packages.
  9. * If Synapse was installed from source, then:
  10. 1. Activate the virtualenv before upgrading. For example, if Synapse is
  11. installed in a virtualenv in ``~/synapse/env`` then run:
  12. .. code:: bash
  13. source ~/synapse/env/bin/activate
  14. 2. If Synapse was installed using pip then upgrade to the latest version by
  15. running:
  16. .. code:: bash
  17. pip install --upgrade matrix-synapse
  18. If Synapse was installed using git then upgrade to the latest version by
  19. running:
  20. .. code:: bash
  21. git pull
  22. pip install --upgrade .
  23. 3. Restart Synapse:
  24. .. code:: bash
  25. ./synctl restart
  26. To check whether your update was successful, you can check the running server
  27. version with:
  28. .. code:: bash
  29. # you may need to replace 'localhost:8008' if synapse is not configured
  30. # to listen on port 8008.
  31. curl http://localhost:8008/_synapse/admin/v1/server_version
  32. Rolling back to older versions
  33. ------------------------------
  34. Rolling back to previous releases can be difficult, due to database schema
  35. changes between releases. Where we have been able to test the rollback process,
  36. this will be noted below.
  37. In general, you will need to undo any changes made during the upgrade process,
  38. for example:
  39. * pip:
  40. .. code:: bash
  41. source env/bin/activate
  42. # replace `1.3.0` accordingly:
  43. pip install matrix-synapse==1.3.0
  44. * Debian:
  45. .. code:: bash
  46. # replace `1.3.0` and `stretch` accordingly:
  47. wget https://packages.matrix.org/debian/pool/main/m/matrix-synapse-py3/matrix-synapse-py3_1.3.0+stretch1_amd64.deb
  48. dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
  49. Upgrading to v1.14.0
  50. ====================
  51. This version includes a database update which is run as part of the upgrade,
  52. and which may take a couple of minutes in the case of a large server. Synapse
  53. will not respond to HTTP requests while this update is taking place.
  54. Upgrading to v1.13.0
  55. ====================
  56. Incorrect database migration in old synapse versions
  57. ----------------------------------------------------
  58. A bug was introduced in Synapse 1.4.0 which could cause the room directory to
  59. be incomplete or empty if Synapse was upgraded directly from v1.2.1 or
  60. earlier, to versions between v1.4.0 and v1.12.x.
  61. This will *not* be a problem for Synapse installations which were:
  62. * created at v1.4.0 or later,
  63. * upgraded via v1.3.x, or
  64. * upgraded straight from v1.2.1 or earlier to v1.13.0 or later.
  65. If completeness of the room directory is a concern, installations which are
  66. affected can be repaired as follows:
  67. 1. Run the following sql from a `psql` or `sqlite3` console:
  68. .. code:: sql
  69. INSERT INTO background_updates (update_name, progress_json, depends_on) VALUES
  70. ('populate_stats_process_rooms', '{}', 'current_state_events_membership');
  71. INSERT INTO background_updates (update_name, progress_json, depends_on) VALUES
  72. ('populate_stats_process_users', '{}', 'populate_stats_process_rooms');
  73. 2. Restart synapse.
  74. New Single Sign-on HTML Templates
  75. ---------------------------------
  76. New templates (``sso_auth_confirm.html``, ``sso_auth_success.html``, and
  77. ``sso_account_deactivated.html``) were added to Synapse. If your Synapse is
  78. configured to use SSO and a custom ``sso_redirect_confirm_template_dir``
  79. configuration then these templates will need to be copied from
  80. `synapse/res/templates <synapse/res/templates>`_ into that directory.
  81. Synapse SSO Plugins Method Deprecation
  82. --------------------------------------
  83. Plugins using the ``complete_sso_login`` method of
  84. ``synapse.module_api.ModuleApi`` should update to using the async/await
  85. version ``complete_sso_login_async`` which includes additional checks. The
  86. non-async version is considered deprecated.
  87. Rolling back to v1.12.4 after a failed upgrade
  88. ----------------------------------------------
  89. v1.13.0 includes a lot of large changes. If something problematic occurs, you
  90. may want to roll-back to a previous version of Synapse. Because v1.13.0 also
  91. includes a new database schema version, reverting that version is also required
  92. alongside the generic rollback instructions mentioned above. In short, to roll
  93. back to v1.12.4 you need to:
  94. 1. Stop the server
  95. 2. Decrease the schema version in the database:
  96. .. code:: sql
  97. UPDATE schema_version SET version = 57;
  98. 3. Downgrade Synapse by following the instructions for your installation method
  99. in the "Rolling back to older versions" section above.
  100. Upgrading to v1.12.0
  101. ====================
  102. This version includes a database update which is run as part of the upgrade,
  103. and which may take some time (several hours in the case of a large
  104. server). Synapse will not respond to HTTP requests while this update is taking
  105. place.
  106. This is only likely to be a problem in the case of a server which is
  107. participating in many rooms.
  108. 0. As with all upgrades, it is recommended that you have a recent backup of
  109. your database which can be used for recovery in the event of any problems.
  110. 1. As an initial check to see if you will be affected, you can try running the
  111. following query from the `psql` or `sqlite3` console. It is safe to run it
  112. while Synapse is still running.
  113. .. code:: sql
  114. SELECT MAX(q.v) FROM (
  115. SELECT (
  116. SELECT ej.json AS v
  117. FROM state_events se INNER JOIN event_json ej USING (event_id)
  118. WHERE se.room_id=rooms.room_id AND se.type='m.room.create' AND se.state_key=''
  119. LIMIT 1
  120. ) FROM rooms WHERE rooms.room_version IS NULL
  121. ) q;
  122. This query will take about the same amount of time as the upgrade process: ie,
  123. if it takes 5 minutes, then it is likely that Synapse will be unresponsive for
  124. 5 minutes during the upgrade.
  125. If you consider an outage of this duration to be acceptable, no further
  126. action is necessary and you can simply start Synapse 1.12.0.
  127. If you would prefer to reduce the downtime, continue with the steps below.
  128. 2. The easiest workaround for this issue is to manually
  129. create a new index before upgrading. On PostgreSQL, his can be done as follows:
  130. .. code:: sql
  131. CREATE INDEX CONCURRENTLY tmp_upgrade_1_12_0_index
  132. ON state_events(room_id) WHERE type = 'm.room.create';
  133. The above query may take some time, but is also safe to run while Synapse is
  134. running.
  135. We assume that no SQLite users have databases large enough to be
  136. affected. If you *are* affected, you can run a similar query, omitting the
  137. ``CONCURRENTLY`` keyword. Note however that this operation may in itself cause
  138. Synapse to stop running for some time. Synapse admins are reminded that
  139. `SQLite is not recommended for use outside a test
  140. environment <https://github.com/matrix-org/synapse/blob/master/README.rst#using-postgresql>`_.
  141. 3. Once the index has been created, the ``SELECT`` query in step 1 above should
  142. complete quickly. It is therefore safe to upgrade to Synapse 1.12.0.
  143. 4. Once Synapse 1.12.0 has successfully started and is responding to HTTP
  144. requests, the temporary index can be removed:
  145. .. code:: sql
  146. DROP INDEX tmp_upgrade_1_12_0_index;
  147. Upgrading to v1.10.0
  148. ====================
  149. Synapse will now log a warning on start up if used with a PostgreSQL database
  150. that has a non-recommended locale set.
  151. See `docs/postgres.md <docs/postgres.md>`_ for details.
  152. Upgrading to v1.8.0
  153. ===================
  154. Specifying a ``log_file`` config option will now cause Synapse to refuse to
  155. start, and should be replaced by with the ``log_config`` option. Support for
  156. the ``log_file`` option was removed in v1.3.0 and has since had no effect.
  157. Upgrading to v1.7.0
  158. ===================
  159. In an attempt to configure Synapse in a privacy preserving way, the default
  160. behaviours of ``allow_public_rooms_without_auth`` and
  161. ``allow_public_rooms_over_federation`` have been inverted. This means that by
  162. default, only authenticated users querying the Client/Server API will be able
  163. to query the room directory, and relatedly that the server will not share
  164. room directory information with other servers over federation.
  165. If your installation does not explicitly set these settings one way or the other
  166. and you want either setting to be ``true`` then it will necessary to update
  167. your homeserver configuration file accordingly.
  168. For more details on the surrounding context see our `explainer
  169. <https://matrix.org/blog/2019/11/09/avoiding-unwelcome-visitors-on-private-matrix-servers>`_.
  170. Upgrading to v1.5.0
  171. ===================
  172. This release includes a database migration which may take several minutes to
  173. complete if there are a large number (more than a million or so) of entries in
  174. the ``devices`` table. This is only likely to a be a problem on very large
  175. installations.
  176. Upgrading to v1.4.0
  177. ===================
  178. New custom templates
  179. --------------------
  180. If you have configured a custom template directory with the
  181. ``email.template_dir`` option, be aware that there are new templates regarding
  182. registration and threepid management (see below) that must be included.
  183. * ``registration.html`` and ``registration.txt``
  184. * ``registration_success.html`` and ``registration_failure.html``
  185. * ``add_threepid.html`` and ``add_threepid.txt``
  186. * ``add_threepid_failure.html`` and ``add_threepid_success.html``
  187. Synapse will expect these files to exist inside the configured template
  188. directory, and **will fail to start** if they are absent.
  189. To view the default templates, see `synapse/res/templates
  190. <https://github.com/matrix-org/synapse/tree/master/synapse/res/templates>`_.
  191. 3pid verification changes
  192. -------------------------
  193. **Note: As of this release, users will be unable to add phone numbers or email
  194. addresses to their accounts, without changes to the Synapse configuration. This
  195. includes adding an email address during registration.**
  196. It is possible for a user to associate an email address or phone number
  197. with their account, for a number of reasons:
  198. * for use when logging in, as an alternative to the user id.
  199. * in the case of email, as an alternative contact to help with account recovery.
  200. * in the case of email, to receive notifications of missed messages.
  201. Before an email address or phone number can be added to a user's account,
  202. or before such an address is used to carry out a password-reset, Synapse must
  203. confirm the operation with the owner of the email address or phone number.
  204. It does this by sending an email or text giving the user a link or token to confirm
  205. receipt. This process is known as '3pid verification'. ('3pid', or 'threepid',
  206. stands for third-party identifier, and we use it to refer to external
  207. identifiers such as email addresses and phone numbers.)
  208. Previous versions of Synapse delegated the task of 3pid verification to an
  209. identity server by default. In most cases this server is ``vector.im`` or
  210. ``matrix.org``.
  211. In Synapse 1.4.0, for security and privacy reasons, the homeserver will no
  212. longer delegate this task to an identity server by default. Instead,
  213. the server administrator will need to explicitly decide how they would like the
  214. verification messages to be sent.
  215. In the medium term, the ``vector.im`` and ``matrix.org`` identity servers will
  216. disable support for delegated 3pid verification entirely. However, in order to
  217. ease the transition, they will retain the capability for a limited
  218. period. Delegated email verification will be disabled on Monday 2nd December
  219. 2019 (giving roughly 2 months notice). Disabling delegated SMS verification
  220. will follow some time after that once SMS verification support lands in
  221. Synapse.
  222. Once delegated 3pid verification support has been disabled in the ``vector.im`` and
  223. ``matrix.org`` identity servers, all Synapse versions that depend on those
  224. instances will be unable to verify email and phone numbers through them. There
  225. are no imminent plans to remove delegated 3pid verification from Sydent
  226. generally. (Sydent is the identity server project that backs the ``vector.im`` and
  227. ``matrix.org`` instances).
  228. Email
  229. ~~~~~
  230. Following upgrade, to continue verifying email (e.g. as part of the
  231. registration process), admins can either:-
  232. * Configure Synapse to use an email server.
  233. * Run or choose an identity server which allows delegated email verification
  234. and delegate to it.
  235. Configure SMTP in Synapse
  236. +++++++++++++++++++++++++
  237. To configure an SMTP server for Synapse, modify the configuration section
  238. headed ``email``, and be sure to have at least the ``smtp_host, smtp_port``
  239. and ``notif_from`` fields filled out.
  240. You may also need to set ``smtp_user``, ``smtp_pass``, and
  241. ``require_transport_security``.
  242. See the `sample configuration file <docs/sample_config.yaml>`_ for more details
  243. on these settings.
  244. Delegate email to an identity server
  245. ++++++++++++++++++++++++++++++++++++
  246. Some admins will wish to continue using email verification as part of the
  247. registration process, but will not immediately have an appropriate SMTP server
  248. at hand.
  249. To this end, we will continue to support email verification delegation via the
  250. ``vector.im`` and ``matrix.org`` identity servers for two months. Support for
  251. delegated email verification will be disabled on Monday 2nd December.
  252. The ``account_threepid_delegates`` dictionary defines whether the homeserver
  253. should delegate an external server (typically an `identity server
  254. <https://matrix.org/docs/spec/identity_service/r0.2.1>`_) to handle sending
  255. confirmation messages via email and SMS.
  256. So to delegate email verification, in ``homeserver.yaml``, set
  257. ``account_threepid_delegates.email`` to the base URL of an identity server. For
  258. example:
  259. .. code:: yaml
  260. account_threepid_delegates:
  261. email: https://example.com # Delegate email sending to example.com
  262. Note that ``account_threepid_delegates.email`` replaces the deprecated
  263. ``email.trust_identity_server_for_password_resets``: if
  264. ``email.trust_identity_server_for_password_resets`` is set to ``true``, and
  265. ``account_threepid_delegates.email`` is not set, then the first entry in
  266. ``trusted_third_party_id_servers`` will be used as the
  267. ``account_threepid_delegate`` for email. This is to ensure compatibility with
  268. existing Synapse installs that set up external server handling for these tasks
  269. before v1.4.0. If ``email.trust_identity_server_for_password_resets`` is
  270. ``true`` and no trusted identity server domains are configured, Synapse will
  271. report an error and refuse to start.
  272. If ``email.trust_identity_server_for_password_resets`` is ``false`` or absent
  273. and no ``email`` delegate is configured in ``account_threepid_delegates``,
  274. then Synapse will send email verification messages itself, using the configured
  275. SMTP server (see above).
  276. that type.
  277. Phone numbers
  278. ~~~~~~~~~~~~~
  279. Synapse does not support phone-number verification itself, so the only way to
  280. maintain the ability for users to add phone numbers to their accounts will be
  281. by continuing to delegate phone number verification to the ``matrix.org`` and
  282. ``vector.im`` identity servers (or another identity server that supports SMS
  283. sending).
  284. The ``account_threepid_delegates`` dictionary defines whether the homeserver
  285. should delegate an external server (typically an `identity server
  286. <https://matrix.org/docs/spec/identity_service/r0.2.1>`_) to handle sending
  287. confirmation messages via email and SMS.
  288. So to delegate phone number verification, in ``homeserver.yaml``, set
  289. ``account_threepid_delegates.msisdn`` to the base URL of an identity
  290. server. For example:
  291. .. code:: yaml
  292. account_threepid_delegates:
  293. msisdn: https://example.com # Delegate sms sending to example.com
  294. The ``matrix.org`` and ``vector.im`` identity servers will continue to support
  295. delegated phone number verification via SMS until such time as it is possible
  296. for admins to configure their servers to perform phone number verification
  297. directly. More details will follow in a future release.
  298. Rolling back to v1.3.1
  299. ----------------------
  300. If you encounter problems with v1.4.0, it should be possible to roll back to
  301. v1.3.1, subject to the following:
  302. * The 'room statistics' engine was heavily reworked in this release (see
  303. `#5971 <https://github.com/matrix-org/synapse/pull/5971>`_), including
  304. significant changes to the database schema, which are not easily
  305. reverted. This will cause the room statistics engine to stop updating when
  306. you downgrade.
  307. The room statistics are essentially unused in v1.3.1 (in future versions of
  308. Synapse, they will be used to populate the room directory), so there should
  309. be no loss of functionality. However, the statistics engine will write errors
  310. to the logs, which can be avoided by setting the following in
  311. `homeserver.yaml`:
  312. .. code:: yaml
  313. stats:
  314. enabled: false
  315. Don't forget to re-enable it when you upgrade again, in preparation for its
  316. use in the room directory!
  317. Upgrading to v1.2.0
  318. ===================
  319. Some counter metrics have been renamed, with the old names deprecated. See
  320. `the metrics documentation <docs/metrics-howto.md#renaming-of-metrics--deprecation-of-old-names-in-12>`_
  321. for details.
  322. Upgrading to v1.1.0
  323. ===================
  324. Synapse v1.1.0 removes support for older Python and PostgreSQL versions, as
  325. outlined in `our deprecation notice <https://matrix.org/blog/2019/04/08/synapse-deprecating-postgres-9-4-and-python-2-x>`_.
  326. Minimum Python Version
  327. ----------------------
  328. Synapse v1.1.0 has a minimum Python requirement of Python 3.5. Python 3.6 or
  329. Python 3.7 are recommended as they have improved internal string handling,
  330. significantly reducing memory usage.
  331. If you use current versions of the Matrix.org-distributed Debian packages or
  332. Docker images, action is not required.
  333. If you install Synapse in a Python virtual environment, please see "Upgrading to
  334. v0.34.0" for notes on setting up a new virtualenv under Python 3.
  335. Minimum PostgreSQL Version
  336. --------------------------
  337. If using PostgreSQL under Synapse, you will need to use PostgreSQL 9.5 or above.
  338. Please see the
  339. `PostgreSQL documentation <https://www.postgresql.org/docs/11/upgrading.html>`_
  340. for more details on upgrading your database.
  341. Upgrading to v1.0
  342. =================
  343. Validation of TLS certificates
  344. ------------------------------
  345. Synapse v1.0 is the first release to enforce
  346. validation of TLS certificates for the federation API. It is therefore
  347. essential that your certificates are correctly configured. See the `FAQ
  348. <docs/MSC1711_certificates_FAQ.md>`_ for more information.
  349. Note, v1.0 installations will also no longer be able to federate with servers
  350. that have not correctly configured their certificates.
  351. In rare cases, it may be desirable to disable certificate checking: for
  352. example, it might be essential to be able to federate with a given legacy
  353. server in a closed federation. This can be done in one of two ways:-
  354. * Configure the global switch ``federation_verify_certificates`` to ``false``.
  355. * Configure a whitelist of server domains to trust via ``federation_certificate_verification_whitelist``.
  356. See the `sample configuration file <docs/sample_config.yaml>`_
  357. for more details on these settings.
  358. Email
  359. -----
  360. When a user requests a password reset, Synapse will send an email to the
  361. user to confirm the request.
  362. Previous versions of Synapse delegated the job of sending this email to an
  363. identity server. If the identity server was somehow malicious or became
  364. compromised, it would be theoretically possible to hijack an account through
  365. this means.
  366. Therefore, by default, Synapse v1.0 will send the confirmation email itself. If
  367. Synapse is not configured with an SMTP server, password reset via email will be
  368. disabled.
  369. To configure an SMTP server for Synapse, modify the configuration section
  370. headed ``email``, and be sure to have at least the ``smtp_host``, ``smtp_port``
  371. and ``notif_from`` fields filled out. You may also need to set ``smtp_user``,
  372. ``smtp_pass``, and ``require_transport_security``.
  373. If you are absolutely certain that you wish to continue using an identity
  374. server for password resets, set ``trust_identity_server_for_password_resets`` to ``true``.
  375. See the `sample configuration file <docs/sample_config.yaml>`_
  376. for more details on these settings.
  377. New email templates
  378. ---------------
  379. Some new templates have been added to the default template directory for the purpose of the
  380. homeserver sending its own password reset emails. If you have configured a custom
  381. ``template_dir`` in your Synapse config, these files will need to be added.
  382. ``password_reset.html`` and ``password_reset.txt`` are HTML and plain text templates
  383. respectively that contain the contents of what will be emailed to the user upon attempting to
  384. reset their password via email. ``password_reset_success.html`` and
  385. ``password_reset_failure.html`` are HTML files that the content of which (assuming no redirect
  386. URL is set) will be shown to the user after they attempt to click the link in the email sent
  387. to them.
  388. Upgrading to v0.99.0
  389. ====================
  390. Please be aware that, before Synapse v1.0 is released around March 2019, you
  391. will need to replace any self-signed certificates with those verified by a
  392. root CA. Information on how to do so can be found at `the ACME docs
  393. <docs/ACME.md>`_.
  394. For more information on configuring TLS certificates see the `FAQ <docs/MSC1711_certificates_FAQ.md>`_.
  395. Upgrading to v0.34.0
  396. ====================
  397. 1. This release is the first to fully support Python 3. Synapse will now run on
  398. Python versions 3.5, or 3.6 (as well as 2.7). We recommend switching to
  399. Python 3, as it has been shown to give performance improvements.
  400. For users who have installed Synapse into a virtualenv, we recommend doing
  401. this by creating a new virtualenv. For example::
  402. virtualenv -p python3 ~/synapse/env3
  403. source ~/synapse/env3/bin/activate
  404. pip install matrix-synapse
  405. You can then start synapse as normal, having activated the new virtualenv::
  406. cd ~/synapse
  407. source env3/bin/activate
  408. synctl start
  409. Users who have installed from distribution packages should see the relevant
  410. package documentation. See below for notes on Debian packages.
  411. * When upgrading to Python 3, you **must** make sure that your log files are
  412. configured as UTF-8, by adding ``encoding: utf8`` to the
  413. ``RotatingFileHandler`` configuration (if you have one) in your
  414. ``<server>.log.config`` file. For example, if your ``log.config`` file
  415. contains::
  416. handlers:
  417. file:
  418. class: logging.handlers.RotatingFileHandler
  419. formatter: precise
  420. filename: homeserver.log
  421. maxBytes: 104857600
  422. backupCount: 10
  423. filters: [context]
  424. console:
  425. class: logging.StreamHandler
  426. formatter: precise
  427. filters: [context]
  428. Then you should update this to be::
  429. handlers:
  430. file:
  431. class: logging.handlers.RotatingFileHandler
  432. formatter: precise
  433. filename: homeserver.log
  434. maxBytes: 104857600
  435. backupCount: 10
  436. filters: [context]
  437. encoding: utf8
  438. console:
  439. class: logging.StreamHandler
  440. formatter: precise
  441. filters: [context]
  442. There is no need to revert this change if downgrading to Python 2.
  443. We are also making available Debian packages which will run Synapse on
  444. Python 3. You can switch to these packages with ``apt-get install
  445. matrix-synapse-py3``, however, please read `debian/NEWS
  446. <https://github.com/matrix-org/synapse/blob/release-v0.34.0/debian/NEWS>`_
  447. before doing so. The existing ``matrix-synapse`` packages will continue to
  448. use Python 2 for the time being.
  449. 2. This release removes the ``riot.im`` from the default list of trusted
  450. identity servers.
  451. If ``riot.im`` is in your homeserver's list of
  452. ``trusted_third_party_id_servers``, you should remove it. It was added in
  453. case a hypothetical future identity server was put there. If you don't
  454. remove it, users may be unable to deactivate their accounts.
  455. 3. This release no longer installs the (unmaintained) Matrix Console web client
  456. as part of the default installation. It is possible to re-enable it by
  457. installing it separately and setting the ``web_client_location`` config
  458. option, but please consider switching to another client.
  459. Upgrading to v0.33.7
  460. ====================
  461. This release removes the example email notification templates from
  462. ``res/templates`` (they are now internal to the python package). This should
  463. only affect you if you (a) deploy your Synapse instance from a git checkout or
  464. a github snapshot URL, and (b) have email notifications enabled.
  465. If you have email notifications enabled, you should ensure that
  466. ``email.template_dir`` is either configured to point at a directory where you
  467. have installed customised templates, or leave it unset to use the default
  468. templates.
  469. Upgrading to v0.27.3
  470. ====================
  471. This release expands the anonymous usage stats sent if the opt-in
  472. ``report_stats`` configuration is set to ``true``. We now capture RSS memory
  473. and cpu use at a very coarse level. This requires administrators to install
  474. the optional ``psutil`` python module.
  475. We would appreciate it if you could assist by ensuring this module is available
  476. and ``report_stats`` is enabled. This will let us see if performance changes to
  477. synapse are having an impact to the general community.
  478. Upgrading to v0.15.0
  479. ====================
  480. If you want to use the new URL previewing API (/_matrix/media/r0/preview_url)
  481. then you have to explicitly enable it in the config and update your dependencies
  482. dependencies. See README.rst for details.
  483. Upgrading to v0.11.0
  484. ====================
  485. This release includes the option to send anonymous usage stats to matrix.org,
  486. and requires that administrators explictly opt in or out by setting the
  487. ``report_stats`` option to either ``true`` or ``false``.
  488. We would really appreciate it if you could help our project out by reporting
  489. anonymized usage statistics from your homeserver. Only very basic aggregate
  490. data (e.g. number of users) will be reported, but it helps us to track the
  491. growth of the Matrix community, and helps us to make Matrix a success, as well
  492. as to convince other networks that they should peer with us.
  493. Upgrading to v0.9.0
  494. ===================
  495. Application services have had a breaking API change in this version.
  496. They can no longer register themselves with a home server using the AS HTTP API. This
  497. decision was made because a compromised application service with free reign to register
  498. any regex in effect grants full read/write access to the home server if a regex of ``.*``
  499. is used. An attack where a compromised AS re-registers itself with ``.*`` was deemed too
  500. big of a security risk to ignore, and so the ability to register with the HS remotely has
  501. been removed.
  502. It has been replaced by specifying a list of application service registrations in
  503. ``homeserver.yaml``::
  504. app_service_config_files: ["registration-01.yaml", "registration-02.yaml"]
  505. Where ``registration-01.yaml`` looks like::
  506. url: <String> # e.g. "https://my.application.service.com"
  507. as_token: <String>
  508. hs_token: <String>
  509. sender_localpart: <String> # This is a new field which denotes the user_id localpart when using the AS token
  510. namespaces:
  511. users:
  512. - exclusive: <Boolean>
  513. regex: <String> # e.g. "@prefix_.*"
  514. aliases:
  515. - exclusive: <Boolean>
  516. regex: <String>
  517. rooms:
  518. - exclusive: <Boolean>
  519. regex: <String>
  520. Upgrading to v0.8.0
  521. ===================
  522. Servers which use captchas will need to add their public key to::
  523. static/client/register/register_config.js
  524. window.matrixRegistrationConfig = {
  525. recaptcha_public_key: "YOUR_PUBLIC_KEY"
  526. };
  527. This is required in order to support registration fallback (typically used on
  528. mobile devices).
  529. Upgrading to v0.7.0
  530. ===================
  531. New dependencies are:
  532. - pydenticon
  533. - simplejson
  534. - syutil
  535. - matrix-angular-sdk
  536. To pull in these dependencies in a virtual env, run::
  537. python synapse/python_dependencies.py | xargs -n 1 pip install
  538. Upgrading to v0.6.0
  539. ===================
  540. To pull in new dependencies, run::
  541. python setup.py develop --user
  542. This update includes a change to the database schema. To upgrade you first need
  543. to upgrade the database by running::
  544. python scripts/upgrade_db_to_v0.6.0.py <db> <server_name> <signing_key>
  545. Where `<db>` is the location of the database, `<server_name>` is the
  546. server name as specified in the synapse configuration, and `<signing_key>` is
  547. the location of the signing key as specified in the synapse configuration.
  548. This may take some time to complete. Failures of signatures and content hashes
  549. can safely be ignored.
  550. Upgrading to v0.5.1
  551. ===================
  552. Depending on precisely when you installed v0.5.0 you may have ended up with
  553. a stale release of the reference matrix webclient installed as a python module.
  554. To uninstall it and ensure you are depending on the latest module, please run::
  555. $ pip uninstall syweb
  556. Upgrading to v0.5.0
  557. ===================
  558. The webclient has been split out into a seperate repository/pacakage in this
  559. release. Before you restart your homeserver you will need to pull in the
  560. webclient package by running::
  561. python setup.py develop --user
  562. This release completely changes the database schema and so requires upgrading
  563. it before starting the new version of the homeserver.
  564. The script "database-prepare-for-0.5.0.sh" should be used to upgrade the
  565. database. This will save all user information, such as logins and profiles,
  566. but will otherwise purge the database. This includes messages, which
  567. rooms the home server was a member of and room alias mappings.
  568. If you would like to keep your history, please take a copy of your database
  569. file and ask for help in #matrix:matrix.org. The upgrade process is,
  570. unfortunately, non trivial and requires human intervention to resolve any
  571. resulting conflicts during the upgrade process.
  572. Before running the command the homeserver should be first completely
  573. shutdown. To run it, simply specify the location of the database, e.g.:
  574. ./scripts/database-prepare-for-0.5.0.sh "homeserver.db"
  575. Once this has successfully completed it will be safe to restart the
  576. homeserver. You may notice that the homeserver takes a few seconds longer to
  577. restart than usual as it reinitializes the database.
  578. On startup of the new version, users can either rejoin remote rooms using room
  579. aliases or by being reinvited. Alternatively, if any other homeserver sends a
  580. message to a room that the homeserver was previously in the local HS will
  581. automatically rejoin the room.
  582. Upgrading to v0.4.0
  583. ===================
  584. This release needs an updated syutil version. Run::
  585. python setup.py develop
  586. You will also need to upgrade your configuration as the signing key format has
  587. changed. Run::
  588. python -m synapse.app.homeserver --config-path <CONFIG> --generate-config
  589. Upgrading to v0.3.0
  590. ===================
  591. This registration API now closely matches the login API. This introduces a bit
  592. more backwards and forwards between the HS and the client, but this improves
  593. the overall flexibility of the API. You can now GET on /register to retrieve a list
  594. of valid registration flows. Upon choosing one, they are submitted in the same
  595. way as login, e.g::
  596. {
  597. type: m.login.password,
  598. user: foo,
  599. password: bar
  600. }
  601. The default HS supports 2 flows, with and without Identity Server email
  602. authentication. Enabling captcha on the HS will add in an extra step to all
  603. flows: ``m.login.recaptcha`` which must be completed before you can transition
  604. to the next stage. There is a new login type: ``m.login.email.identity`` which
  605. contains the ``threepidCreds`` key which were previously sent in the original
  606. register request. For more information on this, see the specification.
  607. Web Client
  608. ----------
  609. The VoIP specification has changed between v0.2.0 and v0.3.0. Users should
  610. refresh any browser tabs to get the latest web client code. Users on
  611. v0.2.0 of the web client will not be able to call those on v0.3.0 and
  612. vice versa.
  613. Upgrading to v0.2.0
  614. ===================
  615. The home server now requires setting up of SSL config before it can run. To
  616. automatically generate default config use::
  617. $ python synapse/app/homeserver.py \
  618. --server-name machine.my.domain.name \
  619. --bind-port 8448 \
  620. --config-path homeserver.config \
  621. --generate-config
  622. This config can be edited if desired, for example to specify a different SSL
  623. certificate to use. Once done you can run the home server using::
  624. $ python synapse/app/homeserver.py --config-path homeserver.config
  625. See the README.rst for more information.
  626. Also note that some config options have been renamed, including:
  627. - "host" to "server-name"
  628. - "database" to "database-path"
  629. - "port" to "bind-port" and "unsecure-port"
  630. Upgrading to v0.0.1
  631. ===================
  632. This release completely changes the database schema and so requires upgrading
  633. it before starting the new version of the homeserver.
  634. The script "database-prepare-for-0.0.1.sh" should be used to upgrade the
  635. database. This will save all user information, such as logins and profiles,
  636. but will otherwise purge the database. This includes messages, which
  637. rooms the home server was a member of and room alias mappings.
  638. Before running the command the homeserver should be first completely
  639. shutdown. To run it, simply specify the location of the database, e.g.:
  640. ./scripts/database-prepare-for-0.0.1.sh "homeserver.db"
  641. Once this has successfully completed it will be safe to restart the
  642. homeserver. You may notice that the homeserver takes a few seconds longer to
  643. restart than usual as it reinitializes the database.
  644. On startup of the new version, users can either rejoin remote rooms using room
  645. aliases or by being reinvited. Alternatively, if any other homeserver sends a
  646. message to a room that the homeserver was previously in the local HS will
  647. automatically rejoin the room.