UPGRADE.rst 44 KB

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