From 04c01882fc8d212defccf56c81fca508599b8a85 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Wed, 6 May 2015 09:59:13 +0100 Subject: [PATCH 01/14] Bump version --- synapse/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/synapse/__init__.py b/synapse/__init__.py index 56c10a84e..c89f444f4 100644 --- a/synapse/__init__.py +++ b/synapse/__init__.py @@ -16,4 +16,4 @@ """ This is a reference implementation of a Matrix home server. """ -__version__ = "0.8.1-r4" +__version__ = "0.9.0" From 271ee604f8ea5ea9d896088a0b2c495d9824f3be Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Wed, 6 May 2015 11:29:54 +0100 Subject: [PATCH 02/14] Update change log --- CHANGES.rst | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index cf6c984d5..9f598a7f8 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,8 +1,32 @@ -Changes in synapse vX -===================== +Changes in synapse v0.9.0 (2015-05-06) +====================================== -* Changed config option from ``disable_registration`` to - ``enable_registration``. Old option will be ignored. +General: + +* Add support for using a PostgreSQL database instead of SQLite. See + ``docs/postgres.rst`` for details. +* Add password change and reset APIs. +* Fix memory leak due to not releasing stale notifiers. +* Fix race in caches that occasionally caused some presence updates to be + dropped. +* Check server name has not changed on restart. + +Federation: + +* Add key distribution mechanisms for fetching public keys of unavailable + remote home servers. + +Configuration: + +* Add support for multiple config files. +* Add support for dictionaries in config files. +* Remove some options from the command line, they should be specified in + config files instead. + +Application services: + +* Reliably retry sending of events from Synapse to application services. +* Implement API change in how application services register with home servers. Changes in synapse v0.8.1 (2015-03-18) From 0e4393652fe00cfebd6515c4e1c6e21e05c44f75 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Wed, 6 May 2015 13:31:59 +0100 Subject: [PATCH 03/14] Update change log to be more detailed --- CHANGES.rst | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 9f598a7f8..889628497 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -14,20 +14,31 @@ General: Federation: * Add key distribution mechanisms for fetching public keys of unavailable - remote home servers. + remote home servers. See `Retrieving Server Keys`_ in the spec. Configuration: * Add support for multiple config files. * Add support for dictionaries in config files. -* Remove some options from the command line, they should be specified in - config files instead. +* Remove support for specifying config options on the command line, except + for: + + * ``--daemonize`` - Daemonize the home server. + * ``--manhole`` - Turn on the twisted telnet manhole service on the given + port. + * ``--database-path`` - The path to a sqlite database to use. + * ``--verbose`` - The verbosity level. + * ``--log-file`` - File to log to. + * ``--log-config`` - Python logging config file. + * ``--enable-registration`` - Enable registration for new users. Application services: * Reliably retry sending of events from Synapse to application services. * Implement API change in how application services register with home servers. +.. _`Retrieving Server Keys`: https://github.com/matrix-org/matrix-doc/blob/6f2698/specification/30_server_server_api.rst#retrieving-server-keys + Changes in synapse v0.8.1 (2015-03-18) ====================================== From 028a570e17d65b8da33e3761b44a705989bc5d7b Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Wed, 6 May 2015 13:42:40 +0100 Subject: [PATCH 04/14] Linkify docs/postgres.sql --- CHANGES.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 889628497..4c16af6dd 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,7 +4,7 @@ Changes in synapse v0.9.0 (2015-05-06) General: * Add support for using a PostgreSQL database instead of SQLite. See - ``docs/postgres.rst`` for details. + `docs/postgres.rst`_ for details. * Add password change and reset APIs. * Fix memory leak due to not releasing stale notifiers. * Fix race in caches that occasionally caused some presence updates to be @@ -37,6 +37,7 @@ Application services: * Reliably retry sending of events from Synapse to application services. * Implement API change in how application services register with home servers. +.. _`docs/postgres.rst`: docs/postgres.rst .. _`Retrieving Server Keys`: https://github.com/matrix-org/matrix-doc/blob/6f2698/specification/30_server_server_api.rst#retrieving-server-keys From 938939fd89518ba6db833c9463973f18d752fefc Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Wed, 6 May 2015 13:48:06 +0100 Subject: [PATCH 05/14] Move CAPTCHA_SETUP to docs/ --- CAPTCHA_SETUP => docs/CAPTCHA_SETUP | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CAPTCHA_SETUP => docs/CAPTCHA_SETUP (100%) diff --git a/CAPTCHA_SETUP b/docs/CAPTCHA_SETUP similarity index 100% rename from CAPTCHA_SETUP rename to docs/CAPTCHA_SETUP From 771fc05d306a5d679729f4d6de39fdd2c3052a7a Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Wed, 6 May 2015 13:59:32 +0100 Subject: [PATCH 06/14] Change log: Link to application services spec. --- CHANGES.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 4c16af6dd..9ca52a57d 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -34,12 +34,13 @@ Configuration: Application services: -* Reliably retry sending of events from Synapse to application services. +* Reliably retry sending of events from Synapse to application services, as per + `Application Services`_ spec. * Implement API change in how application services register with home servers. .. _`docs/postgres.rst`: docs/postgres.rst .. _`Retrieving Server Keys`: https://github.com/matrix-org/matrix-doc/blob/6f2698/specification/30_server_server_api.rst#retrieving-server-keys - +.. _`Application Services`: https://github.com/matrix-org/matrix-doc/blob/0c6bd9/specification/25_application_service_api.rst#home-server---application-service-api Changes in synapse v0.8.1 (2015-03-18) ====================================== From 3188e94ac48430c417a7e07c045835a14c3c540d Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 16:12:02 +0100 Subject: [PATCH 07/14] Explain the change in AS /register api --- CHANGES.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 9ca52a57d..cc47dca6e 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -36,7 +36,10 @@ Application services: * Reliably retry sending of events from Synapse to application services, as per `Application Services`_ spec. -* Implement API change in how application services register with home servers. +* Application services can no longer register via the ``/register`` API, + instead their configuration should be saved to a file and listed in the + synapse ``app_service_config_files`` config option. The AS configuration file + has the same format as the old ``/register`` request. .. _`docs/postgres.rst`: docs/postgres.rst .. _`Retrieving Server Keys`: https://github.com/matrix-org/matrix-doc/blob/6f2698/specification/30_server_server_api.rst#retrieving-server-keys From 4605953b0f0786fee0c66acf1c455675119c06db Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 16:53:18 +0100 Subject: [PATCH 08/14] Add JIRA issue id --- CHANGES.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index cc47dca6e..644244f2d 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -6,9 +6,9 @@ General: * Add support for using a PostgreSQL database instead of SQLite. See `docs/postgres.rst`_ for details. * Add password change and reset APIs. -* Fix memory leak due to not releasing stale notifiers. +* Fix memory leak due to not releasing stale notifiers - SYN-339. * Fix race in caches that occasionally caused some presence updates to be - dropped. + dropped - SYN-369. * Check server name has not changed on restart. Federation: From ac29318b8415b3c066ed846688eb6306f691010f Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 17:58:50 +0100 Subject: [PATCH 09/14] Add link to registration spec --- CHANGES.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 644244f2d..c1f3460bb 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -5,7 +5,7 @@ General: * Add support for using a PostgreSQL database instead of SQLite. See `docs/postgres.rst`_ for details. -* Add password change and reset APIs. +* Add password change and reset APIs. See `Registration`_ in the spec. * Fix memory leak due to not releasing stale notifiers - SYN-339. * Fix race in caches that occasionally caused some presence updates to be dropped - SYN-369. @@ -42,6 +42,7 @@ Application services: has the same format as the old ``/register`` request. .. _`docs/postgres.rst`: docs/postgres.rst +.. _`Registration`: https://github.com/matrix-org/matrix-doc/blob/master/specification/10_client_server_api.rst#registration .. _`Retrieving Server Keys`: https://github.com/matrix-org/matrix-doc/blob/6f2698/specification/30_server_server_api.rst#retrieving-server-keys .. _`Application Services`: https://github.com/matrix-org/matrix-doc/blob/0c6bd9/specification/25_application_service_api.rst#home-server---application-service-api From a151693a3baa667b780805f18515d3dab90039ec Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 18:01:46 +0100 Subject: [PATCH 10/14] Bump syweb version --- synapse/python_dependencies.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/synapse/python_dependencies.py b/synapse/python_dependencies.py index df4b8f7f9..b1baad81c 100644 --- a/synapse/python_dependencies.py +++ b/synapse/python_dependencies.py @@ -33,7 +33,7 @@ REQUIREMENTS = { } CONDITIONAL_REQUIREMENTS = { "web_client": { - "matrix_angular_sdk>=0.6.5": ["syweb>=0.6.5"], + "matrix_angular_sdk>=0.6.6": ["syweb>=0.6.6"], } } @@ -62,8 +62,8 @@ DEPENDENCY_LINKS = [ ), github_link( project="matrix-org/matrix-angular-sdk", - version="v0.6.5", - egg="matrix_angular_sdk-0.6.5", + version="v0.6.6", + egg="matrix_angular_sdk-0.6.6", ), ] From 63562f6d5a114e773150b1feea59b1a1c8575e64 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 18:20:13 +0100 Subject: [PATCH 11/14] Bump date --- CHANGES.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index c1f3460bb..dc9fcf98d 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,4 +1,4 @@ -Changes in synapse v0.9.0 (2015-05-06) +Changes in synapse v0.9.0 (2015-05-07) ====================================== General: From 35698484a51081126d3f8b37a599d7d37a91f5fb Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 18:51:09 +0100 Subject: [PATCH 12/14] Add some information on registering AS's --- CHANGES.rst | 2 ++ docs/application_services.rst | 26 ++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/application_services.rst diff --git a/CHANGES.rst b/CHANGES.rst index dc9fcf98d..f0bb973dc 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -40,8 +40,10 @@ Application services: instead their configuration should be saved to a file and listed in the synapse ``app_service_config_files`` config option. The AS configuration file has the same format as the old ``/register`` request. + See `docs/application_services.rst`_ for more information. .. _`docs/postgres.rst`: docs/postgres.rst +.. _`docs/application_services.rst`: docs/application_services.rst .. _`Registration`: https://github.com/matrix-org/matrix-doc/blob/master/specification/10_client_server_api.rst#registration .. _`Retrieving Server Keys`: https://github.com/matrix-org/matrix-doc/blob/6f2698/specification/30_server_server_api.rst#retrieving-server-keys .. _`Application Services`: https://github.com/matrix-org/matrix-doc/blob/0c6bd9/specification/25_application_service_api.rst#home-server---application-service-api diff --git a/docs/application_services.rst b/docs/application_services.rst new file mode 100644 index 000000000..07236e62a --- /dev/null +++ b/docs/application_services.rst @@ -0,0 +1,26 @@ +Registering an Application Service +================================== + +The registration of new application services is implementation dependent. In +synapse you need to create a new configuration file for you AS and add it to +the list of AS's specified under ``app_service_config_files`` synapse +config option. + +The format of the AS configuration file is as follows:: + + url: + as_token: + hs_token: + sender_localpart: + namespaces: + users: # List of users we're interested in + - exclusive: + regex: + - ... + aliases: [] # List of aliases we're interested in + rooms: [] # List of room ids we're interested in + +See the spec_ for further details on how application services work. + +.. _spec: https://github.com/matrix-org/matrix-doc/blob/master/specification/25_application_service_api.rst#application-service-api + From 5fe26a9b5ccabf68d833afe0021638bbb8deaa4d Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 18:54:53 +0100 Subject: [PATCH 13/14] Reword docs/application_services.rst --- docs/application_services.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/application_services.rst b/docs/application_services.rst index 07236e62a..69f7e41b8 100644 --- a/docs/application_services.rst +++ b/docs/application_services.rst @@ -1,12 +1,14 @@ Registering an Application Service ================================== -The registration of new application services is implementation dependent. In -synapse you need to create a new configuration file for you AS and add it to -the list of AS's specified under ``app_service_config_files`` synapse -config option. +The registration of new application services depends on the homeserver used. +In synapse you need to create a new configuration file for your AS and add it +to the list of AS's specified under the ``app_service_config_files`` config +option in your synapse config. -The format of the AS configuration file is as follows:: +The format of the AS configuration file is as follows: + +.. code-block:: yaml url: as_token: From 6101ce427a3e903449a1be6dbac4419714990298 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 7 May 2015 18:58:28 +0100 Subject: [PATCH 14/14] Slight rewording --- docs/application_services.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/application_services.rst b/docs/application_services.rst index 69f7e41b8..a57bae619 100644 --- a/docs/application_services.rst +++ b/docs/application_services.rst @@ -2,10 +2,18 @@ Registering an Application Service ================================== The registration of new application services depends on the homeserver used. -In synapse you need to create a new configuration file for your AS and add it -to the list of AS's specified under the ``app_service_config_files`` config +In synapse, you need to create a new configuration file for your AS and add it +to the list specified under the ``app_service_config_files`` config option in your synapse config. +For example: + +.. code-block:: yaml + + app_service_config_files: + - /home/matrix/.synapse/.yaml + + The format of the AS configuration file is as follows: .. code-block:: yaml