UPGRADE.rst 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. Upgrading to v0.6.0
  2. ===================
  3. To pull in new dependencies, run::
  4. python setup.py develop --user
  5. This update includes a change to the database schema. To upgrade you first need
  6. to upgrade the database by running::
  7. python scripts/upgrade_db_to_v0.6.0.py <db> <server_name> <signing_key>
  8. Where `<db>` is the location of the database, `<server_name>` is the
  9. server name as specified in the synapse configuration, and `<signing_key>` is
  10. the location of the signing key as specified in the synapse configuration.
  11. This may take some time to complete. Failures of signatures and content hashes
  12. can safely be ignored.
  13. Upgrading to v0.5.1
  14. ===================
  15. Depending on precisely when you installed v0.5.0 you may have ended up with
  16. a stale release of the reference matrix webclient installed as a python module.
  17. To uninstall it and ensure you are depending on the latest module, please run::
  18. $ pip uninstall syweb
  19. Upgrading to v0.5.0
  20. ===================
  21. The webclient has been split out into a seperate repository/pacakage in this
  22. release. Before you restart your homeserver you will need to pull in the
  23. webclient package by running::
  24. python setup.py develop --user
  25. This release completely changes the database schema and so requires upgrading
  26. it before starting the new version of the homeserver.
  27. The script "database-prepare-for-0.5.0.sh" should be used to upgrade the
  28. database. This will save all user information, such as logins and profiles,
  29. but will otherwise purge the database. This includes messages, which
  30. rooms the home server was a member of and room alias mappings.
  31. If you would like to keep your history, please take a copy of your database
  32. file and ask for help in #matrix:matrix.org. The upgrade process is,
  33. unfortunately, non trivial and requires human intervention to resolve any
  34. resulting conflicts during the upgrade process.
  35. Before running the command the homeserver should be first completely
  36. shutdown. To run it, simply specify the location of the database, e.g.:
  37. ./scripts/database-prepare-for-0.5.0.sh "homeserver.db"
  38. Once this has successfully completed it will be safe to restart the
  39. homeserver. You may notice that the homeserver takes a few seconds longer to
  40. restart than usual as it reinitializes the database.
  41. On startup of the new version, users can either rejoin remote rooms using room
  42. aliases or by being reinvited. Alternatively, if any other homeserver sends a
  43. message to a room that the homeserver was previously in the local HS will
  44. automatically rejoin the room.
  45. Upgrading to v0.4.0
  46. ===================
  47. This release needs an updated syutil version. Run::
  48. python setup.py develop
  49. You will also need to upgrade your configuration as the signing key format has
  50. changed. Run::
  51. python -m synapse.app.homeserver --config-path <CONFIG> --generate-config
  52. Upgrading to v0.3.0
  53. ===================
  54. This registration API now closely matches the login API. This introduces a bit
  55. more backwards and forwards between the HS and the client, but this improves
  56. the overall flexibility of the API. You can now GET on /register to retrieve a list
  57. of valid registration flows. Upon choosing one, they are submitted in the same
  58. way as login, e.g::
  59. {
  60. type: m.login.password,
  61. user: foo,
  62. password: bar
  63. }
  64. The default HS supports 2 flows, with and without Identity Server email
  65. authentication. Enabling captcha on the HS will add in an extra step to all
  66. flows: ``m.login.recaptcha`` which must be completed before you can transition
  67. to the next stage. There is a new login type: ``m.login.email.identity`` which
  68. contains the ``threepidCreds`` key which were previously sent in the original
  69. register request. For more information on this, see the specification.
  70. Web Client
  71. ----------
  72. The VoIP specification has changed between v0.2.0 and v0.3.0. Users should
  73. refresh any browser tabs to get the latest web client code. Users on
  74. v0.2.0 of the web client will not be able to call those on v0.3.0 and
  75. vice versa.
  76. Upgrading to v0.2.0
  77. ===================
  78. The home server now requires setting up of SSL config before it can run. To
  79. automatically generate default config use::
  80. $ python synapse/app/homeserver.py \
  81. --server-name machine.my.domain.name \
  82. --bind-port 8448 \
  83. --config-path homeserver.config \
  84. --generate-config
  85. This config can be edited if desired, for example to specify a different SSL
  86. certificate to use. Once done you can run the home server using::
  87. $ python synapse/app/homeserver.py --config-path homeserver.config
  88. See the README.rst for more information.
  89. Also note that some config options have been renamed, including:
  90. - "host" to "server-name"
  91. - "database" to "database-path"
  92. - "port" to "bind-port" and "unsecure-port"
  93. Upgrading to v0.0.1
  94. ===================
  95. This release completely changes the database schema and so requires upgrading
  96. it before starting the new version of the homeserver.
  97. The script "database-prepare-for-0.0.1.sh" should be used to upgrade the
  98. database. This will save all user information, such as logins and profiles,
  99. but will otherwise purge the database. This includes messages, which
  100. rooms the home server was a member of and room alias mappings.
  101. Before running the command the homeserver should be first completely
  102. shutdown. To run it, simply specify the location of the database, e.g.:
  103. ./scripts/database-prepare-for-0.0.1.sh "homeserver.db"
  104. Once this has successfully completed it will be safe to restart the
  105. homeserver. You may notice that the homeserver takes a few seconds longer to
  106. restart than usual as it reinitializes the database.
  107. On startup of the new version, users can either rejoin remote rooms using room
  108. aliases or by being reinvited. Alternatively, if any other homeserver sends a
  109. message to a room that the homeserver was previously in the local HS will
  110. automatically rejoin the room.