From 87b315ce21deca1db67917acd8b40a20ccdd8c2c Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 22 Aug 2014 13:52:38 +0100 Subject: [PATCH] Add CHANGES and UPGRADE files. --- CHANGES | 20 ++++++++++++++++++++ UPGRADE | 23 +++++++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 CHANGES create mode 100644 UPGRADE diff --git a/CHANGES b/CHANGES new file mode 100644 index 000000000..055f8bc01 --- /dev/null +++ b/CHANGES @@ -0,0 +1,20 @@ +Changes in synapse 0.0.1 +======================= +Homeserver: + * Completely change the database schema to support generic event types. + * Improve presence reliability. + * Improve reliability of joining remote rooms. + * Fix bug where room join events were duplicated. + * Improve initial sync API to return more information to the client. + * Stop generating fake messages for room membership events. + +Webclient: + * Add tab completion of names. + * Add ability to upload and send images. + * Add profile pages. + * Improve CSS layout of room. + * Disambiguate identical display names. + * Don't get remote users display names and avatars individually. + * Use the new initial sync API to reduce number of round trips to the homeserver. + * Change url scheme to use room aliases instead of room ids where known. + * Increase longpoll timeout. diff --git a/UPGRADE b/UPGRADE new file mode 100644 index 000000000..95f933597 --- /dev/null +++ b/UPGRADE @@ -0,0 +1,23 @@ +Upgrading to v0.0.1 +================== +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.0.1.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. + +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.0.1.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.