UPGRADE.rst 28 KB

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