CHANGES.rst

Changes in synapse v0.19.0 (2017-02-04)
=======================================

No changes since RC 4.


Changes in synapse v0.19.0-rc4 (2017-02-02)
===========================================

* Bump cache sizes for common membership queries (PR #1879)


Changes in synapse v0.19.0-rc3 (2017-02-02)
===========================================

* Fix email push in pusher worker (PR #1875)
* Make presence.get_new_events a bit faster (PR #1876)
* Make /keys/changes a bit more performant (PR #1877)


Changes in synapse v0.19.0-rc2 (2017-02-02)
===========================================

* Include newly joined users in /keys/changes API (PR #1872)


Changes in synapse v0.19.0-rc1 (2017-02-02)
===========================================

Features:

* Add support for specifying multiple bind addresses (PR #1709, #1712, #1795,
  #1835). Thanks to @kyrias!
* Add /account/3pid/delete endpoint (PR #1714)
* Add config option to configure the Riot URL used in notification emails (PR
  #1811). Thanks to @aperezdc!
* Add username and password config options for turn server (PR #1832). Thanks
  to @xsteadfastx!
* Implement device lists updates over federation (PR #1857, #1861, #1864)
* Implement /keys/changes (PR #1869, #1872)


Changes:

* Improve IPv6 support (PR #1696). Thanks to @kyrias and @glyph!
* Log which files we saved attachments to in the media_repository (PR #1791)
* Linearize updates to membership via PUT /state/ to better handle multiple
  joins (PR #1787)
* Limit number of entries to prefill from cache on startup (PR #1792)
* Remove full_twisted_stacktraces option (PR #1802)
* Measure size of some caches by sum of the size of cached values (PR #1815)
* Measure metrics of string_cache (PR #1821)
* Reduce logging verbosity (PR #1822, #1823, #1824)
* Don't clobber a displayname or avatar_url if provided by an m.room.member
  event (PR #1852)
* Better handle 401/404 response for federation /send/ (PR #1866, #1871)


Fixes:

* Fix ability to change password to a non-ascii one (PR #1711)
* Fix push getting stuck due to looking at the wrong view of state (PR #1820)
* Fix email address comparison to be case insensitive (PR #1827)
* Fix occasional inconsistencies of room membership (PR #1836, #1840)


Performance:

* Don't block messages sending on bumping presence (PR #1789)
* Change device_inbox stream index to include user (PR #1793)
* Optimise state resolution (PR #1818)
* Use DB cache of joined users for presence (PR #1862)
* Add an index to make membership queries faster (PR #1867)


Changes in synapse v0.18.7 (2017-01-09)
=======================================

No changes from v0.18.7-rc2


Changes in synapse v0.18.7-rc2 (2017-01-07)
===========================================

Bug fixes:

* Fix error in rc1's discarding invalid inbound traffic logic that was
  incorrectly discarding missing events


Changes in synapse v0.18.7-rc1 (2017-01-06)
===========================================

Bug fixes:

* Fix error in #PR 1764 to actually fix the nightmare #1753 bug.
* Improve deadlock logging further
* Discard inbound federation traffic from invalid domains, to immunise
  against #1753


Changes in synapse v0.18.6 (2017-01-06)
=======================================

Bug fixes:

* Fix bug when checking if a guest user is allowed to join a room (PR #1772)
  Thanks to Patrik Oldsberg for diagnosing and the fix!


Changes in synapse v0.18.6-rc3 (2017-01-05)
===========================================

Bug fixes:

* Fix bug where we failed to send ban events to the banned server (PR #1758)
* Fix bug where we sent event that didn't originate on this server to
  other servers (PR #1764)
* Fix bug where processing an event from a remote server took a long time
  because we were making long HTTP requests (PR #1765, PR #1744)

Changes:

* Improve logging for debugging deadlocks (PR #1766, PR #1767)


Changes in synapse v0.18.6-rc2 (2016-12-30)
===========================================

Bug fixes:

* Fix memory leak in twisted by initialising logging correctly (PR #1731)
* Fix bug where fetching missing events took an unacceptable amount of time in
  large rooms (PR #1734)


Changes in synapse v0.18.6-rc1 (2016-12-29)
===========================================

Bug fixes:

* Make sure that outbound connections are closed (PR #1725)


Changes in synapse v0.18.5 (2016-12-16)
=======================================

Bug fixes:

* Fix federation /backfill returning events it shouldn't (PR #1700)
* Fix crash in url preview (PR #1701)


Changes in synapse v0.18.5-rc3 (2016-12-13)
===========================================

Features:

* Add support for E2E for guests (PR #1653)
* Add new API appservice specific public room list (PR #1676)
* Add new room membership APIs (PR #1680)


Changes:

* Enable guest access for private rooms by default (PR #653)
* Limit the number of events that can be created on a given room concurrently
  (PR #1620)
* Log the args that we have on UI auth completion (PR #1649)
* Stop generating refresh_tokens (PR #1654)
* Stop putting a time caveat on access tokens (PR #1656)
* Remove unspecced GET endpoints for e2e keys (PR #1694)


Bug fixes:

* Fix handling of 500 and 429's over federation (PR #1650)
* Fix Content-Type header parsing (PR #1660)
* Fix error when previewing sites that include unicode, thanks to kyrias (PR
  #1664)
* Fix some cases where we drop read receipts (PR #1678)
* Fix bug where calls to ``/sync`` didn't correctly timeout (PR #1683)
* Fix bug where E2E key query would fail if a single remote host failed (PR
  #1686)



Changes in synapse v0.18.5-rc2 (2016-11-24)
===========================================

Bug fixes:

* Don't send old events over federation, fixes bug in -rc1.

Changes in synapse v0.18.5-rc1 (2016-11-24)
===========================================

Features:

* Implement "event_fields" in filters (PR #1638)

Changes:

* Use external ldap auth pacakge (PR #1628)
* Split out federation transaction sending to a worker (PR #1635)
* Fail with a coherent error message if `/sync?filter=` is invalid (PR #1636)
* More efficient notif count queries (PR #1644)


Changes in synapse v0.18.4 (2016-11-22)
=======================================

Bug fixes:

* Add workaround for buggy clients that the fail to register (PR #1632)


Changes in synapse v0.18.4-rc1 (2016-11-14)
===========================================

Changes:

* Various database efficiency improvements (PR #1188, #1192)
* Update default config to blacklist more internal IPs, thanks to Euan Kemp (PR
  #1198)
* Allow specifying duration in minutes in config, thanks to Daniel Dent (PR
  #1625)


Bug fixes:

* Fix media repo to set CORs headers on responses (PR #1190)
* Fix registration to not error on non-ascii passwords (PR #1191)
* Fix create event code to limit the number of prev_events (PR #1615)
* Fix bug in transaction ID deduplication (PR #1624)


Changes in synapse v0.18.3 (2016-11-08)
=======================================

SECURITY UPDATE

Explicitly require authentication when using LDAP3. This is the default on
versions of ``ldap3`` above 1.0, but some distributions will package an older
version.

If you are using LDAP3 login and have a version of ``ldap3`` older than 1.0 it
is **CRITICAL to updgrade**.


Changes in synapse v0.18.2 (2016-11-01)
=======================================

No changes since v0.18.2-rc5


Changes in synapse v0.18.2-rc5 (2016-10-28)
===========================================

Bug fixes:

* Fix prometheus process metrics in worker processes (PR #1184)


Changes in synapse v0.18.2-rc4 (2016-10-27)
===========================================

Bug fixes:

* Fix ``user_threepids`` schema delta, which in some instances prevented
  startup after upgrade (PR #1183)


Changes in synapse v0.18.2-rc3 (2016-10-27)
===========================================

Changes:

* Allow clients to supply access tokens as headers (PR #1098)
* Clarify error codes for GET /filter/, thanks to Alexander Maznev (PR #1164)
* Make password reset email field case insensitive (PR #1170)
* Reduce redundant database work in email pusher (PR #1174)
* Allow configurable rate limiting per AS (PR #1175)
* Check whether to ratelimit sooner to avoid work (PR #1176)
* Standardise prometheus metrics (PR #1177)


Bug fixes:

* Fix incredibly slow back pagination query (PR #1178)
* Fix infinite typing bug (PR #1179)


Changes in synapse v0.18.2-rc2 (2016-10-25)
===========================================

(This release did not include the changes advertised and was identical to RC1)


Changes in synapse v0.18.2-rc1 (2016-10-17)
===========================================

Changes:

* Remove redundant event_auth index (PR #1113)
* Reduce DB hits for replication (PR #1141)
* Implement pluggable password auth (PR #1155)
* Remove rate limiting from app service senders and fix get_or_create_user
  requester, thanks to Patrik Oldsberg (PR #1157)
* window.postmessage for Interactive Auth fallback (PR #1159)
* Use sys.executable instead of hardcoded python, thanks to Pedro Larroy
  (PR #1162)
* Add config option for adding additional TLS fingerprints (PR #1167)
* User-interactive auth on delete device (PR #1168)


Bug fixes:

* Fix not being allowed to set your own state_key, thanks to Patrik Oldsberg
  (PR #1150)
* Fix interactive auth to return 401 from for incorrect password (PR #1160,
  #1166)
* Fix email push notifs being dropped (PR #1169)



Changes in synapse v0.18.1 (2016-10-05)
======================================

No changes since v0.18.1-rc1


Changes in synapse v0.18.1-rc1 (2016-09-30)
===========================================

Features:

* Add total_room_count_estimate to ``/publicRooms`` (PR #1133)


Changes:

* Time out typing over federation (PR #1140)
* Restructure LDAP authentication (PR #1153)


Bug fixes:

* Fix 3pid invites when server is already in the room (PR #1136)
* Fix upgrading with SQLite taking lots of CPU for a few days
  after upgrade (PR #1144)
* Fix upgrading from very old database versions (PR #1145)
* Fix port script to work with recently added tables (PR #1146)


Changes in synapse v0.18.0 (2016-09-19)
=======================================

The release includes major changes to the state storage database schemas, which
significantly reduce database size. Synapse will attempt to upgrade the current
data in the background. Servers with large SQLite database may experience
degradation of performance while this upgrade is in progress, therefore you may
want to consider migrating to using Postgres before upgrading very large SQLite
databases


Changes:

* Make public room search case insensitive (PR #1127)


Bug fixes:

* Fix and clean up publicRooms pagination (PR #1129)


Changes in synapse v0.18.0-rc1 (2016-09-16)
===========================================

Features:

* Add ``only=highlight`` on ``/notifications`` (PR #1081)
* Add server param to /publicRooms (PR #1082)
* Allow clients to ask for the whole of a single state event (PR #1094)
* Add is_direct param to /createRoom (PR #1108)
* Add pagination support to publicRooms (PR #1121)
* Add very basic filter API to /publicRooms (PR #1126)
* Add basic direct to device messaging support for E2E (PR #1074, #1084, #1104,
  #1111)


Changes:

* Move to storing state_groups_state as deltas, greatly reducing DB size (PR
  #1065)
* Reduce amount of state pulled out of the DB during common requests (PR #1069)
* Allow PDF to be rendered from media repo (PR #1071)
* Reindex state_groups_state after pruning (PR #1085)
* Clobber EDUs in send queue (PR #1095)
* Conform better to the CAS protocol specification (PR #1100)
* Limit how often we ask for keys from dead servers (PR #1114)


Bug fixes:

* Fix /notifications API when used with ``from`` param (PR #1080)
* Fix backfill when cannot find an event. (PR #1107)


Changes in synapse v0.17.3 (2016-09-09)
=======================================

This release fixes a major bug that stopped servers from handling rooms with
over 1000 members.


Changes in synapse v0.17.2 (2016-09-08)
=======================================

This release contains security bug fixes. Please upgrade.


No changes since v0.17.2-rc1


Changes in synapse v0.17.2-rc1 (2016-09-05)
===========================================

Features:

* Start adding store-and-forward direct-to-device messaging (PR #1046, #1050,
  #1062, #1066)


Changes:

* Avoid pulling the full state of a room out so often (PR #1047, #1049, #1063,
  #1068)
* Don't notify for online to online presence transitions. (PR #1054)
* Occasionally persist unpersisted presence updates (PR #1055)
* Allow application services to have an optional 'url' (PR #1056)
* Clean up old sent transactions from DB (PR #1059)


Bug fixes:

* Fix None check in backfill (PR #1043)
* Fix membership changes to be idempotent (PR #1067)
* Fix bug in get_pdu where it would sometimes return events with incorrect
  signature



Changes in synapse v0.17.1 (2016-08-24)
=======================================

Changes:

* Delete old received_transactions rows (PR #1038)
* Pass through user-supplied content in /join/$room_id (PR #1039)


Bug fixes:

* Fix bug with backfill (PR #1040)


Changes in synapse v0.17.1-rc1 (2016-08-22)
===========================================

Features:

* Add notification API (PR #1028)


Changes:

* Don't print stack traces when failing to get remote keys (PR #996)
* Various federation /event/ perf improvements (PR #998)
* Only process one local membership event per room at a time (PR #1005)
* Move default display name push rule (PR #1011, #1023)
* Fix up preview URL API. Add tests. (PR #1015)
* Set ``Content-Security-Policy`` on media repo (PR #1021)
* Make notify_interested_services faster (PR #1022)
* Add usage stats to prometheus monitoring (PR #1037)


Bug fixes:

* Fix token login (PR #993)
* Fix CAS login (PR #994, #995)
* Fix /sync to not clobber status_msg (PR #997)
* Fix redacted state events to include prev_content (PR #1003)
* Fix some bugs in the auth/ldap handler (PR #1007)
* Fix backfill request to limit URI length, so that remotes don't reject the
  requests due to path length limits (PR #1012)
* Fix AS push code to not send duplicate events (PR #1025)



Changes in synapse v0.17.0 (2016-08-08)
=======================================

This release contains significant security bug fixes regarding authenticating
events received over federation. PLEASE UPGRADE.

This release changes the LDAP configuration format in a backwards incompatible
way, see PR #843 for details.


Changes:

* Add federation /version API (PR #990)
* Make psutil dependency optional (PR #992)


Bug fixes:

* Fix URL preview API to exclude HTML comments in description (PR #988)
* Fix error handling of remote joins (PR #991)


Changes in synapse v0.17.0-rc4 (2016-08-05)
===========================================

Changes:

* Change the way we summarize URLs when previewing (PR #973)
* Add new ``/state_ids/`` federation API (PR #979)
* Speed up processing of ``/state/`` response (PR #986)

Bug fixes:

* Fix event persistence when event has already been partially persisted
  (PR #975, #983, #985)
* Fix port script to also copy across backfilled events (PR #982)


Changes in synapse v0.17.0-rc3 (2016-08-02)
===========================================

Changes:

* Forbid non-ASes from registering users whose names begin with '_' (PR #958)
* Add some basic admin API docs (PR #963)


Bug fixes:

* Send the correct host header when fetching keys (PR #941)
* Fix joining a room that has missing auth events (PR #964)
* Fix various push bugs (PR #966, #970)
* Fix adding emails on registration (PR #968)


Changes in synapse v0.17.0-rc2 (2016-08-02)
===========================================

(This release did not include the changes advertised and was identical to RC1)


Changes in synapse v0.17.0-rc1 (2016-07-28)
===========================================

This release changes the LDAP configuration format in a backwards incompatible
way, see PR #843 for details.


Features:

* Add purge_media_cache admin API (PR #902)
* Add deactivate account admin API (PR #903)
* Add optional pepper to password hashing (PR #907, #910 by KentShikama)
* Add an admin option to shared secret registration (breaks backwards compat)
  (PR #909)
* Add purge local room history API (PR #911, #923, #924)
* Add requestToken endpoints (PR #915)
* Add an /account/deactivate endpoint (PR #921)
* Add filter param to /messages. Add 'contains_url' to filter. (PR #922)
* Add device_id support to /login (PR #929)
* Add device_id support to /v2/register flow. (PR #937, #942)
* Add GET /devices endpoint (PR #939, #944)
* Add GET /device/{deviceId} (PR #943)
* Add update and delete APIs for devices (PR #949)


Changes:

* Rewrite LDAP Authentication against ldap3 (PR #843 by mweinelt)
* Linearize some federation endpoints based on (origin, room_id) (PR #879)
* Remove the legacy v0 content upload API. (PR #888)
* Use similar naming we use in email notifs for push (PR #894)
* Optionally include password hash in createUser endpoint (PR #905 by
  KentShikama)
* Use a query that postgresql optimises better for get_events_around (PR #906)
* Fall back to 'username' if 'user' is not given for appservice registration.
  (PR #927 by Half-Shot)
* Add metrics for psutil derived memory usage (PR #936)
* Record device_id in client_ips (PR #938)
* Send the correct host header when fetching keys (PR #941)
* Log the hostname the reCAPTCHA was completed on (PR #946)
* Make the device id on e2e key upload optional (PR #956)
* Add r0.2.0 to the "supported versions" list (PR #960)
* Don't include name of room for invites in push (PR #961)


Bug fixes:

* Fix substitution failure in mail template (PR #887)
* Put most recent 20 messages in email notif (PR #892)
* Ensure that the guest user is in the database when upgrading accounts
  (PR #914)
* Fix various edge cases in auth handling (PR #919)
* Fix 500 ISE when sending alias event without a state_key (PR #925)
* Fix bug where we stored rejections in the state_group, persist all
  rejections (PR #948)
* Fix lack of check of if the user is banned when handling 3pid invites
  (PR #952)
* Fix a couple of bugs in the transaction and keyring code (PR #954, #955)



Changes in synapse v0.16.1-r1 (2016-07-08)
==========================================

THIS IS A CRITICAL SECURITY UPDATE.

This fixes a bug which allowed users' accounts to be accessed by unauthorised
users.

Changes in synapse v0.16.1 (2016-06-20)
=======================================

Bug fixes:

* Fix assorted bugs in ``/preview_url`` (PR #872)
* Fix TypeError when setting unicode passwords (PR #873)


Performance improvements:

* Turn ``use_frozen_events`` off by default (PR #877)
* Disable responding with canonical json for federation (PR #878)


Changes in synapse v0.16.1-rc1 (2016-06-15)
===========================================

Features: None

Changes:

* Log requester for ``/publicRoom`` endpoints when possible (PR #856)
* 502 on ``/thumbnail`` when can't connect to remote server (PR #862)
* Linearize fetching of gaps on incoming events (PR #871)


Bugs fixes:

* Fix bug where rooms where marked as published by default (PR #857)
* Fix bug where joining room with an event with invalid sender (PR #868)
* Fix bug where backfilled events were sent down sync streams (PR #869)
* Fix bug where outgoing connections could wedge indefinitely, causing push
  notifications to be unreliable (PR #870)


Performance improvements:

* Improve ``/publicRooms`` performance(PR #859)


Changes in synapse v0.16.0 (2016-06-09)
=======================================

NB: As of v0.14 all AS config files must have an ID field.


Bug fixes:

* Don't make rooms published by default (PR #857)

Changes in synapse v0.16.0-rc2 (2016-06-08)
===========================================

Features:

* Add configuration option for tuning GC via ``gc.set_threshold`` (PR #849)

Changes:

* Record metrics about GC (PR #771, #847, #852)
* Add metric counter for number of persisted events (PR #841)

Bug fixes:

* Fix 'From' header in email notifications (PR #843)
* Fix presence where timeouts were not being fired for the first 8h after
  restarts (PR #842)
* Fix bug where synapse sent malformed transactions to AS's when retrying
  transactions (Commits 310197b, 8437906)

Performance improvements:

* Remove event fetching from DB threads (PR #835)
* Change the way we cache events (PR #836)
* Add events to cache when we persist them (PR #840)


Changes in synapse v0.16.0-rc1 (2016-06-03)
===========================================

Version 0.15 was not released. See v0.15.0-rc1 below for additional changes.

Features:

* Add email notifications for missed messages (PR #759, #786, #799, #810, #815,
  #821)
* Add a ``url_preview_ip_range_whitelist`` config param (PR #760)
* Add /report endpoint (PR #762)
* Add basic ignore user API (PR #763)
* Add an openidish mechanism for proving that you own a given user_id (PR #765)
* Allow clients to specify a server_name to avoid 'No known servers' (PR #794)
* Add secondary_directory_servers option to fetch room list from other servers
  (PR #808, #813)

Changes:

* Report per request metrics for all of the things using request_handler (PR
  #756)
* Correctly handle ``NULL`` password hashes from the database (PR #775)
* Allow receipts for events we haven't seen in the db (PR #784)
* Make synctl read a cache factor from config file (PR #785)
* Increment badge count per missed convo, not per msg (PR #793)
* Special case m.room.third_party_invite event auth to match invites (PR #814)


Bug fixes:

* Fix typo in event_auth servlet path (PR #757)
* Fix password reset (PR #758)


Performance improvements:

* Reduce database inserts when sending transactions (PR #767)
* Queue events by room for persistence (PR #768)
* Add cache to ``get_user_by_id`` (PR #772)
* Add and use ``get_domain_from_id`` (PR #773)
* Use tree cache for ``get_linearized_receipts_for_room`` (PR #779)
* Remove unused indices (PR #782)
* Add caches to ``bulk_get_push_rules*`` (PR #804)
* Cache ``get_event_reference_hashes`` (PR #806)
* Add ``get_users_with_read_receipts_in_room`` cache (PR #809)
* Use state to calculate ``get_users_in_room`` (PR #811)
* Load push rules in storage layer so that they get cached (PR #825)
* Make ``get_joined_hosts_for_room`` use get_users_in_room (PR #828)
* Poke notifier on next reactor tick (PR #829)
* Change CacheMetrics to be quicker (PR #830)


Changes in synapse v0.15.0-rc1 (2016-04-26)
===========================================

Features:

* Add login support for Javascript Web Tokens, thanks to Niklas Riekenbrauck
  (PR #671,#687)
* Add URL previewing support (PR #688)
* Add login support for LDAP, thanks to Christoph Witzany (PR #701)
* Add GET endpoint for pushers (PR #716)

Changes:

* Never notify for member events (PR #667)
* Deduplicate identical ``/sync`` requests (PR #668)
* Require user to have left room to forget room (PR #673)
* Use DNS cache if within TTL (PR #677)
* Let users see their own leave events (PR #699)
* Deduplicate membership changes (PR #700)
* Increase performance of pusher code (PR #705)
* Respond with error status 504 if failed to talk to remote server (PR #731)
* Increase search performance on postgres (PR #745)

Bug fixes:

* Fix bug where disabling all notifications still resulted in push (PR #678)
* Fix bug where users couldn't reject remote invites if remote refused (PR #691)
* Fix bug where synapse attempted to backfill from itself (PR #693)
* Fix bug where profile information was not correctly added when joining remote
  rooms (PR #703)
* Fix bug where register API required incorrect key name for AS registration
  (PR #727)


Changes in synapse v0.14.0 (2016-03-30)
=======================================

No changes from v0.14.0-rc2

Changes in synapse v0.14.0-rc2 (2016-03-23)
===========================================

Features:

* Add published room list API (PR #657)

Changes:

* Change various caches to consume less memory (PR #656, #658, #660, #662,
  #663, #665)
* Allow rooms to be published without requiring an alias (PR #664)
* Intern common strings in caches to reduce memory footprint (#666)

Bug fixes:

* Fix reject invites over federation (PR #646)
* Fix bug where registration was not idempotent (PR #649)
* Update aliases event after deleting aliases (PR #652)
* Fix unread notification count, which was sometimes wrong (PR #661)

Changes in synapse v0.14.0-rc1 (2016-03-14)
===========================================

Features:

* Add event_id to response to state event PUT (PR #581)
* Allow guest users access to messages in rooms they have joined (PR #587)
* Add config for what state is included in a room invite (PR #598)
* Send the inviter's member event in room invite state (PR #607)
* Add error codes for malformed/bad JSON in /login (PR #608)
* Add support for changing the actions for default rules (PR #609)
* Add environment variable SYNAPSE_CACHE_FACTOR, default it to 0.1 (PR #612)
* Add ability for alias creators to delete aliases (PR #614)
* Add profile information to invites (PR #624)

Changes:

* Enforce user_id exclusivity for AS registrations (PR #572)
* Make adding push rules idempotent (PR #587)
* Improve presence performance (PR #582, #586)
* Change presence semantics for ``last_active_ago`` (PR #582, #586)
* Don't allow ``m.room.create`` to be changed (PR #596)
* Add 800x600 to default list of valid thumbnail sizes (PR #616)
* Always include kicks and bans in full /sync (PR #625)
* Send history visibility on boundary changes (PR #626)
* Register endpoint now returns a refresh_token (PR #637)

Bug fixes:

* Fix bug where we returned incorrect state in /sync (PR #573)
* Always return a JSON object from push rule API (PR #606)
* Fix bug where registering without a user id sometimes failed (PR #610)
* Report size of ExpiringCache in cache size metrics (PR #611)
* Fix rejection of invites to empty rooms (PR #615)
* Fix usage of ``bcrypt`` to not use ``checkpw`` (PR #619)
* Pin ``pysaml2`` dependency (PR #634)
* Fix bug in ``/sync`` where timeline order was incorrect for backfilled events
  (PR #635)

Changes in synapse v0.13.3 (2016-02-11)
=======================================

* Fix bug where ``/sync`` would occasionally return events in the wrong room.

Changes in synapse v0.13.2 (2016-02-11)
=======================================

* Fix bug where ``/events`` would fail to skip some events if there had been
  more events than the limit specified since the last request (PR #570)

Changes in synapse v0.13.1 (2016-02-10)
=======================================

* Bump matrix-angular-sdk (matrix web console) dependency to 0.6.8 to
  pull in the fix for SYWEB-361 so that the default client can display
  HTML messages again(!)

Changes in synapse v0.13.0 (2016-02-10)
=======================================

This version includes an upgrade of the schema, specifically adding an index to
the ``events`` table. This may cause synapse to pause for several minutes the
first time it is started after the upgrade.

Changes:

* Improve general performance (PR #540, #543. #544, #54, #549, #567)
* Change guest user ids to be incrementing integers (PR #550)
* Improve performance of public room list API (PR #552)
* Change profile API to omit keys rather than return null (PR #557)
* Add ``/media/r0`` endpoint prefix, which is equivalent to ``/media/v1/``
  (PR #595)

Bug fixes:

* Fix bug with upgrading guest accounts where it would fail if you opened the
  registration email on a different device (PR #547)
* Fix bug where unread count could be wrong (PR #568)



Changes in synapse v0.12.1-rc1 (2016-01-29)
===========================================

Features:

* Add unread notification counts in ``/sync`` (PR #456)
* Add support for inviting 3pids in ``/createRoom`` (PR #460)
* Add ability for guest accounts to upgrade (PR #462)
* Add ``/versions`` API (PR #468)
* Add ``event`` to ``/context`` API (PR #492)
* Add specific error code for invalid user names in ``/register`` (PR #499)
* Add support for push badge counts (PR #507)
* Add support for non-guest users to peek in rooms using ``/events`` (PR #510)

Changes:

* Change ``/sync`` so that guest users only get rooms they've joined (PR #469)
* Change to require unbanning before other membership changes (PR #501)
* Change default push rules to notify for all messages (PR #486)
* Change default push rules to not notify on membership changes (PR #514)
* Change default push rules in one to one rooms to only notify for events that
  are messages (PR #529)
* Change ``/sync`` to reject requests with a ``from`` query param (PR #512)
* Change server manhole to use SSH rather than telnet (PR #473)
* Change server to require AS users to be registered before use (PR #487)
* Change server not to start when ASes are invalidly configured (PR #494)
* Change server to require ID and ``as_token`` to be unique for AS's (PR #496)
* Change maximum pagination limit to 1000 (PR #497)

Bug fixes:

* Fix bug where ``/sync`` didn't return when something under the leave key
  changed (PR #461)
* Fix bug where we returned smaller rather than larger than requested
  thumbnails when ``method=crop`` (PR #464)
* Fix thumbnails API to only return cropped thumbnails when asking for a
  cropped thumbnail (PR #475)
* Fix bug where we occasionally still logged access tokens (PR #477)
* Fix bug where ``/events`` would always return immediately for guest users
  (PR #480)
* Fix bug where ``/sync`` unexpectedly returned old left rooms (PR #481)
* Fix enabling and disabling push rules (PR #498)
* Fix bug where ``/register`` returned 500 when given unicode username
  (PR #513)

Changes in synapse v0.12.0 (2016-01-04)
=======================================

* Expose ``/login`` under ``r0`` (PR #459)

Changes in synapse v0.12.0-rc3 (2015-12-23)
===========================================

* Allow guest accounts access to ``/sync`` (PR #455)
* Allow filters to include/exclude rooms at the room level
  rather than just from the components of the sync for each
  room. (PR #454)
* Include urls for room avatars in the response to ``/publicRooms`` (PR #453)
* Don't set a identicon as the avatar for a user when they register (PR #450)
* Add a ``display_name`` to third-party invites (PR #449)
* Send more information to the identity server for third-party invites so that
  it can send richer messages to the invitee (PR #446)
* Cache the responses to ``/initialSync`` for 5 minutes. If a client
  retries a request to ``/initialSync`` before the a response was computed
  to the first request then the same response is used for both requests
  (PR #457)
* Fix a bug where synapse would always request the signing keys of
  remote servers even when the key was cached locally (PR #452)
* Fix 500 when pagination search results (PR #447)
* Fix a bug where synapse was leaking raw email address in third-party invites
  (PR #448)

Changes in synapse v0.12.0-rc2 (2015-12-14)
===========================================

* Add caches for whether rooms have been forgotten by a user (PR #434)
* Remove instructions to use ``--process-dependency-link`` since all of the
  dependencies of synapse are on PyPI (PR #436)
* Parallelise the processing of ``/sync`` requests (PR #437)
* Fix race updating presence in ``/events`` (PR #444)
* Fix bug back-populating search results (PR #441)
* Fix bug calculating state in ``/sync`` requests (PR #442)

Changes in synapse v0.12.0-rc1 (2015-12-10)
===========================================

* Host the client APIs released as r0 by
  https://matrix.org/docs/spec/r0.0.0/client_server.html
  on paths prefixed by ``/_matrix/client/r0``. (PR #430, PR #415, PR #400)
* Updates the client APIs to match r0 of the matrix specification.

  * All APIs return events in the new event format, old APIs also include
    the fields needed to parse the event using the old format for
    compatibility. (PR #402)
  * Search results are now given as a JSON array rather than
    a JSON object (PR #405)
  * Miscellaneous changes to search (PR #403, PR #406, PR #412)
  * Filter JSON objects may now be passed as query parameters to ``/sync``
    (PR #431)