From 5b46ce579ba9a198546ff9e19f743eb91a126422 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Wed, 19 Nov 2014 18:00:57 +0000 Subject: Bump version, changelog and upgrade.rst --- UPGRADE.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) (limited to 'UPGRADE.rst') diff --git a/UPGRADE.rst b/UPGRADE.rst index 99ce1a2d3d..2229470c3f 100644 --- a/UPGRADE.rst +++ b/UPGRADE.rst @@ -1,3 +1,33 @@ +Upgrading to v0.5.0 +=================== + +This release completely changes the database schema and so requires upgrading +it before starting the new version of the homeserver. + +The script "database-prepare-for-0.5.0.sh" should be used to upgrade the +database. This will save all user information, such as logins and profiles, +but will otherwise purge the database. This includes messages, which +rooms the home server was a member of and room alias mappings. + +If you would like to keep your history, please take a copy of your database +file and ask for help in #matrix:matrix.org. The upgrade process is, +unfortunately, non trivial and requires human intervention to resolve any +resutling conflicts during the upgrade process. + +Before running the command the homeserver should be first completely +shutdown. To run it, simply specify the location of the database, e.g.: + + ./database-prepare-for-0.5.0.sh "homeserver.db" + +Once this has successfully completed it will be safe to restart the +homeserver. You may notice that the homeserver takes a few seconds longer to +restart than usual as it reinitializes the database. + +On startup of the new version, users can either rejoin remote rooms using room +aliases or by being reinvited. Alternatively, if any other homeserver sends a +message to a room that the homeserver was previously in the local HS will +automatically rejoin the room. + Upgrading to v0.4.0 =================== -- cgit 1.4.1 From bf7940d7ff4d38298904b1b747631500632133c0 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Wed, 19 Nov 2014 20:07:21 +0000 Subject: Add note about rerunning setup.py develop --- UPGRADE.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'UPGRADE.rst') diff --git a/UPGRADE.rst b/UPGRADE.rst index 2229470c3f..8c70ae2765 100644 --- a/UPGRADE.rst +++ b/UPGRADE.rst @@ -1,6 +1,12 @@ Upgrading to v0.5.0 =================== +The webclient has been split out into a seperate repository/pacakage in this +release. Before you restart your homeserver you will need to pull in the +webclient package by running:: + + python setup.py develop --user + This release completely changes the database schema and so requires upgrading it before starting the new version of the homeserver. -- cgit 1.4.1 From 25fd4d9f2c7f99b0932ae9468c1141669e1999cc Mon Sep 17 00:00:00 2001 From: Matthew Hodgson Date: Wed, 19 Nov 2014 15:25:23 -0800 Subject: typoe --- UPGRADE.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'UPGRADE.rst') diff --git a/UPGRADE.rst b/UPGRADE.rst index 8c70ae2765..961f4da31c 100644 --- a/UPGRADE.rst +++ b/UPGRADE.rst @@ -18,7 +18,7 @@ rooms the home server was a member of and room alias mappings. If you would like to keep your history, please take a copy of your database file and ask for help in #matrix:matrix.org. The upgrade process is, unfortunately, non trivial and requires human intervention to resolve any -resutling conflicts during the upgrade process. +resulting conflicts during the upgrade process. Before running the command the homeserver should be first completely shutdown. To run it, simply specify the location of the database, e.g.: -- cgit 1.4.1