update sample config

* rewrite & simplify

* changelog

* cleanup potential sql injection

CHANGES.md

@@ -1,3 +1,102 @@
+Synapse 0.99.3 (2019-04-01)
+===========================
+
+No significant changes.
+
+
+Synapse 0.99.3rc1 (2019-03-27)
+==============================
+
+Features
+--------
+
+- The user directory has been rewritten to make it faster, with less chance of falling behind on a large server. ([\#4537](https://github.com/matrix-org/synapse/issues/4537), [\#4846](https://github.com/matrix-org/synapse/issues/4846), [\#4864](https://github.com/matrix-org/synapse/issues/4864), [\#4887](https://github.com/matrix-org/synapse/issues/4887), [\#4900](https://github.com/matrix-org/synapse/issues/4900), [\#4944](https://github.com/matrix-org/synapse/issues/4944))
+- Add configurable rate limiting to the /register endpoint. ([\#4735](https://github.com/matrix-org/synapse/issues/4735), [\#4804](https://github.com/matrix-org/synapse/issues/4804))
+- Move server key queries to federation reader. ([\#4757](https://github.com/matrix-org/synapse/issues/4757))
+- Add support for /account/3pid REST endpoint to client_reader worker. ([\#4759](https://github.com/matrix-org/synapse/issues/4759))
+- Add an endpoint to the admin API for querying the server version. Contributed by Joseph Weston. ([\#4772](https://github.com/matrix-org/synapse/issues/4772))
+- Include a default configuration file in the 'docs' directory. ([\#4791](https://github.com/matrix-org/synapse/issues/4791), [\#4801](https://github.com/matrix-org/synapse/issues/4801))
+- Synapse is now permissive about trailing slashes on some of its federation endpoints, allowing zero or more to be present. ([\#4793](https://github.com/matrix-org/synapse/issues/4793))
+- Add support for /keys/query and /keys/changes REST endpoints to client_reader worker. ([\#4796](https://github.com/matrix-org/synapse/issues/4796))
+- Add checks to incoming events over federation for events evading auth (aka "soft fail"). ([\#4814](https://github.com/matrix-org/synapse/issues/4814))
+- Add configurable rate limiting to the /login endpoint. ([\#4821](https://github.com/matrix-org/synapse/issues/4821), [\#4865](https://github.com/matrix-org/synapse/issues/4865))
+- Remove trailing slashes from certain outbound federation requests. Retry if receiving a 404. Context: #3622. ([\#4840](https://github.com/matrix-org/synapse/issues/4840))
+- Allow passing --daemonize flags to workers in the same way as with master. ([\#4853](https://github.com/matrix-org/synapse/issues/4853))
+- Batch up outgoing read-receipts to reduce federation traffic. ([\#4890](https://github.com/matrix-org/synapse/issues/4890), [\#4927](https://github.com/matrix-org/synapse/issues/4927))
+- Add option to disable searching the user directory. ([\#4895](https://github.com/matrix-org/synapse/issues/4895))
+- Add option to disable searching of local and remote public room lists. ([\#4896](https://github.com/matrix-org/synapse/issues/4896))
+- Add ability for password providers to login/register a user via 3PID (email, phone). ([\#4931](https://github.com/matrix-org/synapse/issues/4931))
+
+
+Bugfixes
+--------
+
+- Fix a bug where media with spaces in the name would get a corrupted name. ([\#2090](https://github.com/matrix-org/synapse/issues/2090))
+- Fix attempting to paginate in rooms where server cannot see any events, to avoid unnecessarily pulling in lots of redacted events. ([\#4699](https://github.com/matrix-org/synapse/issues/4699))
+- 'event_id' is now a required parameter in federated state requests, as per the matrix spec. ([\#4740](https://github.com/matrix-org/synapse/issues/4740))
+- Fix tightloop over connecting to replication server. ([\#4749](https://github.com/matrix-org/synapse/issues/4749))
+- Fix parsing of Content-Disposition headers on remote media requests and URL previews. ([\#4763](https://github.com/matrix-org/synapse/issues/4763))
+- Fix incorrect log about not persisting duplicate state event. ([\#4776](https://github.com/matrix-org/synapse/issues/4776))
+- Fix v4v6 option in HAProxy example config. Contributed by Flakebi. ([\#4790](https://github.com/matrix-org/synapse/issues/4790))
+- Handle batch updates in worker replication protocol. ([\#4792](https://github.com/matrix-org/synapse/issues/4792))
+- Fix bug where we didn't correctly throttle sending of USER_IP commands over replication. ([\#4818](https://github.com/matrix-org/synapse/issues/4818))
+- Fix potential race in handling missing updates in device list updates. ([\#4829](https://github.com/matrix-org/synapse/issues/4829))
+- Fix bug where synapse expected an un-specced `prev_state` field on state events. ([\#4837](https://github.com/matrix-org/synapse/issues/4837))
+- Transfer a user's notification settings (push rules) on room upgrade. ([\#4838](https://github.com/matrix-org/synapse/issues/4838))
+- fix test_auto_create_auto_join_where_no_consent. ([\#4886](https://github.com/matrix-org/synapse/issues/4886))
+- Fix a bug where hs_disabled_message was sometimes not correctly enforced. ([\#4888](https://github.com/matrix-org/synapse/issues/4888))
+- Fix bug in shutdown room admin API where it would fail if a user in the room hadn't consented to the privacy policy. ([\#4904](https://github.com/matrix-org/synapse/issues/4904))
+- Fix bug where blocked world-readable rooms were still peekable. ([\#4908](https://github.com/matrix-org/synapse/issues/4908))
+
+
+Internal Changes
+----------------
+
+- Add a systemd setup that supports synapse workers. Contributed by Luca Corbatto. ([\#4662](https://github.com/matrix-org/synapse/issues/4662))
+- Change from TravisCI to Buildkite for CI. ([\#4752](https://github.com/matrix-org/synapse/issues/4752))
+- When presence is disabled don't send over replication. ([\#4757](https://github.com/matrix-org/synapse/issues/4757))
+- Minor docstring fixes for MatrixFederationAgent. ([\#4765](https://github.com/matrix-org/synapse/issues/4765))
+- Optimise EDU transmission for the federation_sender worker. ([\#4770](https://github.com/matrix-org/synapse/issues/4770))
+- Update test_typing to use HomeserverTestCase. ([\#4771](https://github.com/matrix-org/synapse/issues/4771))
+- Update URLs for riot.im icons and logos in the default notification templates. ([\#4779](https://github.com/matrix-org/synapse/issues/4779))
+- Removed unnecessary $ from some federation endpoint path regexes. ([\#4794](https://github.com/matrix-org/synapse/issues/4794))
+- Remove link to deleted title in README. ([\#4795](https://github.com/matrix-org/synapse/issues/4795))
+- Clean up read-receipt handling. ([\#4797](https://github.com/matrix-org/synapse/issues/4797))
+- Add some debug about processing read receipts. ([\#4798](https://github.com/matrix-org/synapse/issues/4798))
+- Clean up some replication code. ([\#4799](https://github.com/matrix-org/synapse/issues/4799))
+- Add some docstrings. ([\#4815](https://github.com/matrix-org/synapse/issues/4815))
+- Add debug logger to try and track down #4422. ([\#4816](https://github.com/matrix-org/synapse/issues/4816))
+- Make shutdown API send explanation message to room after users have been forced joined. ([\#4817](https://github.com/matrix-org/synapse/issues/4817))
+- Update example_log_config.yaml. ([\#4820](https://github.com/matrix-org/synapse/issues/4820))
+- Document the `generate` option for the docker image. ([\#4824](https://github.com/matrix-org/synapse/issues/4824))
+- Fix check-newsfragment for debian-only changes. ([\#4825](https://github.com/matrix-org/synapse/issues/4825))
+- Add some debug logging for device list updates to help with #4828. ([\#4828](https://github.com/matrix-org/synapse/issues/4828))
+- Improve federation documentation, specifically .well-known support. Many thanks to @vaab. ([\#4832](https://github.com/matrix-org/synapse/issues/4832))
+- Disable captcha registration by default in unit tests. ([\#4839](https://github.com/matrix-org/synapse/issues/4839))
+- Add stuff back to the .gitignore. ([\#4843](https://github.com/matrix-org/synapse/issues/4843))
+- Clarify what registration_shared_secret allows for. ([\#4844](https://github.com/matrix-org/synapse/issues/4844))
+- Correctly log expected errors when fetching server keys. ([\#4847](https://github.com/matrix-org/synapse/issues/4847))
+- Update install docs to explicitly state a full-chain (not just the top-level) TLS certificate must be provided to Synapse. This caused some people's Synapse ports to appear correct in a browser but still (rightfully so) upset the federation tester. ([\#4849](https://github.com/matrix-org/synapse/issues/4849))
+- Move client read-receipt processing to federation sender worker. ([\#4852](https://github.com/matrix-org/synapse/issues/4852))
+- Refactor federation TransactionQueue. ([\#4855](https://github.com/matrix-org/synapse/issues/4855))
+- Comment out most options in the generated config. ([\#4863](https://github.com/matrix-org/synapse/issues/4863))
+- Fix yaml library warnings by using safe_load. ([\#4869](https://github.com/matrix-org/synapse/issues/4869))
+- Update Apache setup to remove location syntax. Thanks to @cwmke! ([\#4870](https://github.com/matrix-org/synapse/issues/4870))
+- Reinstate test case that runs unit tests against oldest supported dependencies. ([\#4879](https://github.com/matrix-org/synapse/issues/4879))
+- Update link to federation docs. ([\#4881](https://github.com/matrix-org/synapse/issues/4881))
+- fix test_auto_create_auto_join_where_no_consent. ([\#4886](https://github.com/matrix-org/synapse/issues/4886))
+- Use a regular HomeServerConfig object for unit tests rater than a Mock. ([\#4889](https://github.com/matrix-org/synapse/issues/4889))
+- Add some notes about tuning postgres for larger deployments. ([\#4895](https://github.com/matrix-org/synapse/issues/4895))
+- Add a config option for torture-testing worker replication. ([\#4902](https://github.com/matrix-org/synapse/issues/4902))
+- Log requests which are simulated by the unit tests. ([\#4905](https://github.com/matrix-org/synapse/issues/4905))
+- Allow newsfragments to end with exclamation marks. Exciting! ([\#4912](https://github.com/matrix-org/synapse/issues/4912))
+- Refactor some more tests to use HomeserverTestCase. ([\#4913](https://github.com/matrix-org/synapse/issues/4913))
+- Refactor out the state deltas portion of the user directory store and handler. ([\#4917](https://github.com/matrix-org/synapse/issues/4917))
+- Fix nginx example in ACME doc. ([\#4923](https://github.com/matrix-org/synapse/issues/4923))
+- Use an explicit dbname for postgres connections in the tests. ([\#4928](https://github.com/matrix-org/synapse/issues/4928))
+- Fix `ClientReplicationStreamProtocol.__str__()`. ([\#4929](https://github.com/matrix-org/synapse/issues/4929))
+
+
 Synapse 0.99.2 (2019-03-01)
 ===========================
 

INSTALL.md

@@ -384,7 +384,7 @@ To configure Synapse to expose an HTTPS port, you will need to edit
   `cert.pem`).
 
 For those of you upgrading your TLS certificate in readiness for Synapse 1.0,
-please take a look at `our guide <docs/MSC1711_certificates_FAQ.md#configuring-certificates-for-compatibility-with-synapse-100>`_.
+please take a look at [our guide](docs/MSC1711_certificates_FAQ.md#configuring-certificates-for-compatibility-with-synapse-100).
 
 ## Registering a user
 

changelog.d/2090.bugfix

@@ -1 +0,0 @@
-Fix a bug where media with spaces in the name would get a corrupted name.

changelog.d/4474.misc

@@ -0,0 +1 @@
+Add test to verify threepid auth check added in #4435.

changelog.d/4537.feature

@@ -1 +0,0 @@
-The user directory has been rewritten to make it faster, with less chance of falling behind on a large server.

changelog.d/4555.bugfix

@@ -0,0 +1 @@
+Avoid redundant URL encoding of redirect URL for SSO login in the fallback login page. Fixes a regression introduced in [#4220](https://github.com/matrix-org/synapse/pull/4220). Contributed by Marcel Fabian Krüger ("[zaugin](https://github.com/zauguin)").

changelog.d/4662.misc

@@ -1 +0,0 @@
-Add a systemd setup that supports synapse workers. Contributed by Luca Corbatto.

changelog.d/4699.bugfix

@@ -1 +0,0 @@
-Fix attempting to paginate in rooms where server cannot see any events, to avoid unnecessarily pulling in lots of redacted events.

changelog.d/4735.feature

@@ -1 +0,0 @@
-Add configurable rate limiting to the /register endpoint.

changelog.d/4740.bugfix

@@ -1 +0,0 @@
-'event_id' is now a required parameter in federated state requests, as per the matrix spec.

changelog.d/4749.bugfix

@@ -1 +0,0 @@
-Fix tightloop over connecting to replication server.

changelog.d/4752.misc

@@ -1 +0,0 @@
-Change from TravisCI to Buildkite for CI.

changelog.d/4757.feature

@@ -1 +0,0 @@
-Move server key queries to federation reader.

changelog.d/4757.misc

@@ -1 +0,0 @@
-When presence is disabled don't send over replication.

changelog.d/4759.feature

@@ -1 +0,0 @@
-Add support for /account/3pid REST endpoint to client_reader worker.

changelog.d/4763.bugfix

@@ -1 +0,0 @@
-Fix parsing of Content-Disposition headers on remote media requests and URL previews.

changelog.d/4765.misc

@@ -1 +0,0 @@
-Minor docstring fixes for MatrixFederationAgent.

changelog.d/4770.misc

@@ -1 +0,0 @@
-Optimise EDU transmission for the federation_sender worker.

changelog.d/4771.misc

@@ -1 +0,0 @@
-Update test_typing to use HomeserverTestCase.

changelog.d/4772.feature

@@ -1 +0,0 @@
-Add an endpoint to the admin API for querying the server version. Contributed by Joseph Weston.

changelog.d/4776.bugfix

@@ -1 +0,0 @@
-Fix incorrect log about not persisting duplicate state event.

changelog.d/4779.misc

@@ -1 +0,0 @@
-Update URLs for riot.im icons and logos in the default notification templates.

changelog.d/4790.bugfix

@@ -1 +0,0 @@
-Fix v4v6 option in HAProxy example config. Contributed by Flakebi.

changelog.d/4791.feature

@@ -1 +0,0 @@
-Include a default configuration file in the 'docs' directory.

changelog.d/4792.bugfix

@@ -1 +0,0 @@
-Handle batch updates in worker replication protocol.

changelog.d/4793.feature

@@ -1 +0,0 @@
-Synapse is now permissive about trailing slashes on some of its federation endpoints, allowing zero or more to be present.

changelog.d/4794.misc

@@ -1 +0,0 @@
-Removed unnecessary $ from some federation endpoint path regexes.

changelog.d/4795.misc

@@ -1 +0,0 @@
-Remove link to deleted title in README.

changelog.d/4796.feature

@@ -1 +0,0 @@
-Add support for /keys/query and /keys/changes REST endpoints to client_reader worker.

changelog.d/4797.misc

@@ -1 +0,0 @@
-Clean up read-receipt handling.

changelog.d/4798.misc

@@ -1 +0,0 @@
-Add some debug about processing read receipts.

changelog.d/4799.misc

@@ -1 +0,0 @@
-Clean up some replication code.

changelog.d/4801.feature

@@ -1 +0,0 @@
-Include a default configuration file in the 'docs' directory.

changelog.d/4804.feature

@@ -1 +0,0 @@
-Add configurable rate limiting to the /register endpoint.

changelog.d/4814.feature

@@ -1 +0,0 @@
-Add checks to incoming events over federation for events evading auth (aka "soft fail").

changelog.d/4815.misc

@@ -1 +0,0 @@
-Add some docstrings.

changelog.d/4816.misc

@@ -1 +0,0 @@
-Add debug logger to try and track down #4422.

changelog.d/4817.misc

@@ -1 +0,0 @@
-Make shutdown API send explanation message to room after users have been forced joined.

changelog.d/4818.bugfix

@@ -1 +0,0 @@
-Fix bug where we didn't correctly throttle sending of USER_IP commands over replication.

changelog.d/4820.misc

@@ -1 +0,0 @@
-Update example_log_config.yaml.

changelog.d/4821.feature

@@ -1 +0,0 @@
-Add configurable rate limiting to the /login endpoint.

changelog.d/4824.misc

@@ -1 +0,0 @@
-Document the `generate` option for the docker image.

changelog.d/4825.misc

@@ -1 +0,0 @@
-Fix check-newsfragment for debian-only changes.

changelog.d/4828.misc

@@ -1 +0,0 @@
-Add some debug logging for device list updates to help with #4828.

changelog.d/4829.bugfix

@@ -1 +0,0 @@
-Fix potential race in handling missing updates in device list updates.

changelog.d/4832.misc

@@ -1 +0,0 @@
-Improve federation documentation, specifically .well-known support. Many thanks to @vaab.

changelog.d/4837.bugfix

@@ -1 +0,0 @@
-Fix bug where synapse expected an un-specced `prev_state` field on state events.

changelog.d/4838.bugfix

@@ -1 +0,0 @@
-Transfer a user's notification settings (push rules) on room upgrade.

changelog.d/4839.misc

@@ -1 +0,0 @@
-Disable captcha registration by default in unit tests.

changelog.d/4840.feature

@@ -1 +0,0 @@
-Remove trailing slashes from certain outbound federation requests. Retry if receiving a 404. Context: #3622.

changelog.d/4843.misc

@@ -1 +0,0 @@
-Add stuff back to the .gitignore.

changelog.d/4844.misc

@@ -1 +0,0 @@
-Clarify what registration_shared_secret allows for.

changelog.d/4846.feature

@@ -1 +0,0 @@
-The user directory has been rewritten to make it faster, with less chance of falling behind on a large server.

changelog.d/4847.misc

@@ -1 +0,0 @@
-Correctly log expected errors when fetching server keys.

changelog.d/4849.misc

@@ -1 +0,0 @@
-Update install docs to explicitly state a full-chain (not just the top-level) TLS certificate must be provided to Synapse. This caused some people's Synapse ports to appear correct in a browser but still (rightfully so) upset the federation tester.

changelog.d/4852.misc

@@ -1 +0,0 @@
- Move client read-receipt processing to federation sender worker.

changelog.d/4853.feature

@@ -1 +0,0 @@
-Allow passing --daemonize flags to workers in the same way as with master.

changelog.d/4855.misc

@@ -1 +0,0 @@
-Refactor federation TransactionQueue.

changelog.d/4863.misc

@@ -1 +0,0 @@
-Comment out most options in the generated config.

changelog.d/4864.feature

@@ -1 +0,0 @@
-The user directory has been rewritten to make it faster, with less chance of falling behind on a large server.

changelog.d/4865.feature

@@ -1 +0,0 @@
-Add configurable rate limiting to the /login endpoint.

changelog.d/4869.misc

@@ -1 +0,0 @@
-Fix yaml library warnings by using safe_load.

changelog.d/4870.misc

@@ -1 +0,0 @@
-Update Apache setup to remove location syntax. Thanks to @cwmke!

changelog.d/4879.misc

@@ -1 +0,0 @@
-Reinstate test case that runs unit tests against oldest supported dependencies.

changelog.d/4881.misc

@@ -1 +0,0 @@
-Update link to federation docs.

changelog.d/4886.bugfix

@@ -1 +0,0 @@
-fix test_auto_create_auto_join_where_no_consent.

changelog.d/4886.misc

@@ -1 +0,0 @@
-fix test_auto_create_auto_join_where_no_consent.

changelog.d/4887.feature

@@ -1 +0,0 @@
-The user directory has been rewritten to make it faster, with less chance of falling behind on a large server. 

changelog.d/4888.bugfix

@@ -1,2 +0,0 @@
-Fix a bug where hs_disabled_message was sometimes not correctly enforced.
-

changelog.d/4889.misc

@@ -1 +0,0 @@
-Use a regular HomeServerConfig object for unit tests rater than a Mock.

changelog.d/4890.feature

@@ -1 +0,0 @@
-Batch up outgoing read-receipts to reduce federation traffic.

changelog.d/4895.feature

@@ -1 +0,0 @@
-Add option to disable searching the user directory.

changelog.d/4895.misc

@@ -1 +0,0 @@
-Add some notes about tuning postgres for larger deployments.

changelog.d/4896.feature

@@ -1 +0,0 @@
-Add option to disable searching of local and remote public room lists.

changelog.d/4900.feature

@@ -1 +0,0 @@
-The user directory has been rewritten to make it faster, with less chance of falling behind on a large server.

changelog.d/4902.misc

@@ -1 +0,0 @@
-Add a config option for torture-testing worker replication.

changelog.d/4904.bugfix

@@ -1 +0,0 @@
-Fix bug in shutdown room admin API where it would fail if a user in the room hadn't consented to the privacy policy.

changelog.d/4905.misc

@@ -1 +0,0 @@
-Log requests which are simulated by the unit tests.

changelog.d/4908.bugfix

@@ -1 +0,0 @@
-Fix bug where blocked world-readable rooms were still peekable.

changelog.d/4912.misc

@@ -1 +0,0 @@
-Allow newsfragments to end with exclamation marks. Exciting!

changelog.d/4913.misc

@@ -1 +0,0 @@
-Refactor some more tests to use HomeserverTestCase.

changelog.d/4917.misc

@@ -1 +0,0 @@
-Refactor out the state deltas portion of the user directory store and handler.

changelog.d/4923.misc

@@ -1 +0,0 @@
-Fix nginx example in ACME doc.

changelog.d/4927.feature

@@ -1 +0,0 @@
-Batch up outgoing read-receipts to reduce federation traffic.

changelog.d/4928.misc

@@ -1 +0,0 @@
-Use an explicit dbname for postgres connections in the tests.

changelog.d/4929.misc

@@ -1 +0,0 @@
-Fix `ClientReplicationStreamProtocol.__str__()`.

changelog.d/4931.feature

@@ -1 +0,0 @@
-Add ability for password providers to login/register a user via 3PID (email, phone).

changelog.d/4944.feature

@@ -1 +0,0 @@
-The user directory has been rewritten to make it faster, with less chance of falling behind on a large server.

changelog.d/4954.misc

@@ -0,0 +1 @@
+Refactor replication row generation/parsing.

changelog.d/4955.bugfix

@@ -0,0 +1 @@
+Fix sync bug which made accepting invites unreliable in worker-mode synapses.

changelog.d/4956.bugfix

@@ -0,0 +1 @@
+Fix sync bug which made accepting invites unreliable in worker-mode synapses.

changelog.d/4965.misc

@@ -0,0 +1 @@
+Remove log line for password via the admin API.

changelog.d/4968.misc

@@ -0,0 +1 @@
+Fix typo in TLS filenames in docker/README.md. Also add the '-p' commandline option to the 'docker run' example. Contributed by Jurrie Overgoor.

changelog.d/4969.misc

@@ -0,0 +1,2 @@
+Refactor room version definitions.
+

changelog.d/4974.misc

@@ -0,0 +1 @@
+Add `config.signing_key_path` that can be read by `synapse.config` utility.

changelog.d/4981.bugfix

@@ -0,0 +1 @@
+start.sh: Fix the --no-rate-limit option for messages and make it bypass rate limit on registration and login too.

changelog.d/4982.misc

@@ -0,0 +1 @@
+Track which identity server is used when binding a threepid and use that for unbinding, as per MSC1915.

changelog.d/4985.misc

@@ -0,0 +1 @@
+Rewrite KeyringTestCase as a HomeserverTestCase.

changelog.d/4987.misc

@@ -0,0 +1 @@
+README updates: Corrected the default POSTGRES_USER. Added port forwarding hint in TLS section.

changelog.d/4989.feature

@@ -0,0 +1 @@
+Remove presence list support as per MSC 1819.