1
0

UPGRADE.rst 28 KB

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