summary refs log tree commit diff
path: root/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Remove documentation of legacy `frontend_proxy` worker app (#13645)Richard van der Hoff2022-08-302-41/+22
| | | | | This has been the same as a generic_worker since #6964, so let's get rid of it. Fixes #3717
* Clarify documentation about replication traffic. (#13656)Patrick Cloke2022-08-301-1/+4
| | | | It can be authenticated with the worker_replication_secret setting, but is always unencrypted.
* Improve documentation around user registration (#13640)Richard van der Hoff2022-08-263-103/+133
| | | | | Update a bunch of the documentation for user registration, add some cross links, etc.
* Generate missing configuration files at startup (#13615)Richard van der Hoff2022-08-261-1/+7
| | | | | | | | If things like the signing key file are missing, let's just try to generate them on startup. Again, this is useful for k8s-like deployments where we just want to generate keys on the first run.
* Support `registration_shared_secret` in a file (#13614)Richard van der Hoff2022-08-251-0/+18
| | | | A new `registration_shared_secret_path` option. This is kinda handy for k8s deployments and things.
* Write about the chain cover a little. (#13602)David Robertson2022-08-231-9/+42
| | | Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Update openid.md (#13568)nilsKr32022-08-231-1/+3
| | | Linking the help article may prevent confusion regarding the creation of the necessary rule using auth0.
* Drop support for delegating email validation, round 2 (#13596)David Robertson2022-08-232-1/+23
|
* Describe changes to admin API in 1.66David Robertson2022-08-231-0/+2
| | | | Cross-ref #13525
* Implement MSC3852: Expose `last_seen_user_agent` to users for their own ↵Andrew Morgan2022-08-191-0/+7
| | | | devices; also expose to Admin API (#13549)
* Add support for compression to federation responses (#13537)Ayush Anand2022-08-181-1/+1
| | | | | | Closes #13415. Signed-off-by: Ayush Anand <iamayushanand@gmail.com>
* A first pass at pruning the Synapse README (#13491)David Robertson2022-08-171-4/+86
|
* Fix a typo in docs and in some warnings (#13538)Antonin Loubiere2022-08-171-1/+1
|
* Add forgotten status to Room Details API (#13503)Dirk Klimpel2022-08-171-1/+4
|
* Add missing links in `user_consent` section of configuration manual (#13536)Dirk Klimpel2022-08-161-2/+2
| | | Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
* Add a warning to retention documentation regarding the possibility of ↵Shay2022-08-152-2/+7
| | | | database corruption (#13497)
* Add `openssl` example for registration HMAC (#13472)James Barton2022-08-111-2/+19
| | | Signed-off-by: James Barton <james@neodon.com>
* Add note to `redaction_retention_period` documentation mentioning that event ↵Andrew Morgan2022-08-111-0/+4
| | | | purging runs at most every 5m (#13492)
* Make the configuration for the cache clearer (#13481)Dirk Klimpel2022-08-091-4/+5
|
* Mark token-authenticaticated-registration API as not-experimental (#11897)Julian-Samuel Gebühr2022-08-051-3/+3
|
* Update some outdated information on `sso_mapping_providers.md` (#13449)Dirk Klimpel2022-08-041-6/+8
|
* Fix return value in example on `password_auth_provider_callbacks.md` (#13450)Dirk Klimpel2022-08-041-2/+2
| | | | | Fixes: #12534 Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
* Improve documentation on becoming server admin (#13230)jejo862022-08-031-1/+2
| | | | | | | | | | | | | | | | | | | | | | | * Improved section regarding server admin Added steps describing how to elevate an existing user to administrator by manipulating a `postgres` database. Signed-off-by: jejo86 28619134+jejo86@users.noreply.github.com * Improved section regarding server admin * Reference database settings Add instructions to check database settings to find out the database name, instead of listing all available PostgreSQL databases. * Add suggestions from PR conversation Replace config filename `homeserver.yaml`. with "config file". Remove instructions to switch to `postgres` user. Add instructions how to connect to SQLite database. * Update changelog.d/13230.doc Co-authored-by: reivilibre <olivier@librepush.net>
* Update doc for setting `macaroon_secret_key` (#13443)Dirk Klimpel2022-08-031-3/+7
| | | | | * Update doc for setting `macaroon_secret_key` * newsfile
* Remove 'Contents' section from the Configuration Manual (#13438)Dirk Klimpel2022-08-031-43/+0
| | | Fixes: #13053
* Fix wrong headline for `url_preview_accept_language` in docs (#13437)Dirk Klimpel2022-08-031-1/+1
| | | Fixes: #13433
* Merge branch 'master' into developOlivier Wilkinson (reivilibre)2022-08-021-0/+10
|\
| * Add upgrade notesOlivier Wilkinson (reivilibre)2022-08-021-0/+10
| |
* | Merge tag 'v1.64.0rc2' into developRichard van der Hoff2022-07-292-194/+181
|\| | | | | | | | | | | | | Synapse 1.64.0rc2 (2022-07-29) ============================== This RC reintroduces support for `account_threepid_delegates.email`, which was removed in 1.64.0rc1. It remains deprecated and will be removed altogether in a future release. ([\#13406](https://github.com/matrix-org/synapse/issues/13406))
| * Revert "Drop support for delegating email validation (#13192)" (#13406)3nprob2022-07-292-194/+181
| | | | | | | | | | Reverts commit fa71bb18b527d1a3e2629b48640ea67fff2f8c59, and tweaks documentation. Signed-off-by: 3nprob <git@3n.anonaddy.com>
* | Explicitly mention which resources support compression in the config guide ↵Brendan Abolivier2022-07-291-1/+2
|/ | | | (#13221)
* Update Caddy reverse proxy documentation (#13344)Matt Holt2022-07-251-42/+11
| | | | | Improve/simplify Caddy examples. Remove Caddy v1 (has long been EOL'ed) Signed-off-by: Matthew Holt <mholt@users.noreply.github.com>
* Support Implicit TLS for sending emails (#13317)Jan Schär2022-07-251-1/+10
| | | | | | | | | | Previously, TLS could only be used with STARTTLS. Add a new option `force_tls`, where TLS is used from the start. Implicit TLS is recommended over STARTLS, see https://datatracker.ietf.org/doc/html/rfc8314 Fixes #8046. Signed-off-by: Jan Schär <jan@jschaer.ch>
* Update config_documentation.md (#13364)Richard van der Hoff2022-07-221-2/+2
| | | "changed in" goes before the example
* Update locked frozendict version to 2.3.3 (#13352)Sean Quah2022-07-221-0/+9
| | | frozendict 2.3.3 includes fixes for memory leaks that get triggered during `/sync`.
* Merge branch 'master' into developDavid Robertson2022-07-211-0/+8
|\
| * Document `rc_invites.per_issuer`, added in v1.63.David Teller2022-07-211-0/+8
| | | | | | | | | | | | | | Resolves #13330. Missed in #13125. Signed-off-by: David Teller <davidt@element.io>
* | Merge branch 'master' into developBrendan Abolivier2022-07-193-8/+13
|\|
| * Remove 'anonymised' from the phone home stats documentation (#13321)Andrew Morgan2022-07-193-8/+13
| |
* | Add notes when config options were changed to config documentation (#13314)Jörg Behrmann2022-07-191-0/+5
| | | | | | | | Signed-off-by: Jörg Behrmann <behrmann@physik.fu-berlin.de>
* | Rate limit joins per-room (#13276)David Robertson2022-07-192-0/+29
| |
* | Use and recommend poetry 1.1.14, up from 1.1.12 (#13285)David Robertson2022-07-151-0/+25
| |
* | Document advising against publicly exposing the Admin API and provide a ↵jejo862022-07-131-0/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | usage example (#13231) * Admin API request explanation improved Pointed out, that the Admin API is not accessible by default from any remote computer, but only from the PC `matrix-synapse` is running on. Added a full, working example, making sure to include the cURL flag `-X`, which needs to be prepended to `GET`, `POST`, `PUT` etc. and listing the full query string including protocol, IP address and port. * Admin API request explanation improved * Apply suggestions from code review Update changelog. Reword prose. Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
* | Inline URL preview documentation. (#13261)Patrick Cloke2022-07-124-68/+2
| | | | | | Inline URL preview documentation near the implementation.
* | Drop support for delegating email validation (#13192)Richard van der Hoff2022-07-122-16/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Drop support for delegating email validation Delegating email validation to an IS is insecure (since it allows the owner of the IS to do a password reset on your HS), and has long been deprecated. It will now cause a config error at startup. * Update unit test which checks for email verification Give it an `email` config instead of a threepid delegate * Remove unused method `requestEmailToken` * Simplify config handling for email verification Rather than an enum and a boolean, all we need here is a single bool, which says whether we are or are not doing email verification. * update docs * changelog * upgrade.md: fix typo * update version number this will be in 1.64, not 1.63 * update version number this one too
* | Add info about configuration in the url preview docs (#13233)Shay2022-07-121-0/+1
| | | | | | Cross-link doc pages for easier navigation.
* | expose whether a room is a space in the Admin API (#13208)andrew do2022-07-121-8/+21
|/
* Document the 'databases' homeserver config option (#13212)Andrew Morgan2022-07-111-0/+92
|
* Check that `auto_vacuum` is disabled when porting a SQLite database to ↵reivilibre2022-07-071-0/+8
| | | | Postgres, as `VACUUM`s must not be performed between runs of the script. (#13195)
* Add information on how the Synapse team does reviews. (#13132)Patrick Cloke2022-07-063-1/+46
|
* Add the ability to set the log level using the `SYNAPSE_TEST_LOG_LEVEL` ↵reivilibre2022-07-051-0/+4
| | | | environment when using `complement.sh`. (#13152)
* Add missing links to config options (#13166)Dirk Klimpel2022-07-051-3/+3
|
* Add documentation for phone home stats (#13086)Andrew Morgan2022-06-302-0/+82
|
* Cleanup references to sample config in the docs and redirect users to ↵Shay2022-06-3010-88/+69
| | | | configuration manual (#13077)
* Add a link to the configuration manual from the homeserver sample config ↵Andrew Morgan2022-06-301-0/+3
| | | | documentation page (#13139)
* Fix documentation header for `allow_public_rooms_over_federation` (#13116)Moritz Stückler2022-06-291-1/+1
| | | | Signed-off-by: Moritz Stückler <moritz.stueckler@gmail.com> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Document the `--report-stats` argument (#13029)jejo862022-06-291-1/+3
| | | Signed-off-by: jejo86 <28619134+jejo86@users.noreply.github.com>
* Remove docs for Delete Group Admin API (#13112)Aaron Raimist2022-06-272-15/+0
| | | | | | This API no longer exists. Signed-off-by: Aaron Raimist <aaron@raim.ist>
* Update opentracing docs to reference the configuration manual rather than ↵Shay2022-06-171-2/+3
| | | | the configuation file. (#13076)
* Update info on downstream debs (#13095)Richard van der Hoff2022-06-171-9/+8
|
* Add custom well-known (#13035)Jacek Kuśnierz2022-06-161-0/+17
| | | Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
* Add instructions for running Complement with `gotestfmt`-formatted output ↵reivilibre2022-06-161-0/+14
| | | | locally. (#13073)
* Add headers to individual options in config documentation to allow for ↵Shay2022-06-151-163/+163
| | | | linking. (#13055)
* Change default `sync_response_cache_duration` (#13042)Erik Johnston2022-06-151-2/+2
|
* Replace pyjwt with authlib in `org.matrix.login.jwt` (#13011)Hannes Lerchl2022-06-152-14/+27
|
* Fix version number in spam checker callbacks doc (#13047)Brendan Abolivier2022-06-141-6/+6
|
* Remove code generating comments in configuration file (#12941)Shay2022-06-142-2838/+12
|
* Merge branch 'release-v1.61' into developErik Johnston2022-06-141-17/+19
|\
| * Fixup upgrades v1.61.0Erik Johnston2022-06-141-3/+3
| |
| * Mention removed community/group worker endpoints in upgrade.md (#13023)Sami Olmari2022-06-141-0/+18
| |
* | Mention removed community/group worker endpoints in upgrade.md (#13023)Sami Olmari2022-06-141-0/+16
| |
* | Uniformize spam-checker API, part 4: port other spam-checker callbacks to ↵David Teller2022-06-132-56/+175
| | | | | | | | | | return `Union[Allow, Codes]`. (#12857) Co-authored-by: Brendan Abolivier <babolivier@matrix.org>
* | Add missing TOC link to poetry cheat sheet (#13022)David Robertson2022-06-101-0/+1
| | | | | | Missed by #12475.
* | Merge the Complement testing Docker images into a single, multi-purpose ↵reivilibre2022-06-081-0/+5
|/ | | | | image. (#12881) Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* Prevent local quarantined media from being claimed by media retention (#12972)Andrew Morgan2022-06-071-0/+6
|
* Allow updating passwords using the admin api without logging out devices ↵Jan Christian Grünhage2022-06-061-1/+3
| | | | (#12952)
* Remove remaining bits of groups code. (#12936)Patrick Cloke2022-06-011-6/+0
| | | | | | * Update worker docs to remove group endpoints. * Removes an unused parameter to `ApplicationService`. * Break dependency between media repo and groups. * Avoid copying `m.room.related_groups` state events during room upgrades.
* Add config options for media retention (#12732)Andrew Morgan2022-05-311-1/+28
|
* Merge branch 'master' into developErik Johnston2022-05-312-20/+19
|\
| * Fix import in module_api module and docs on the new check_event_for_spam ↵Brendan Abolivier2022-05-312-20/+19
| | | | | | | | | | signature (#12918) Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* | Add a background job to automatically delete stale devices (#12855)Brendan Abolivier2022-05-271-0/+12
| | | | | | Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* | Merge tag 'v1.60.0rc2' into developSean Quah2022-05-272-1/+6
|\| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Synapse 1.60.0rc2 (2022-05-27) ============================== This release of Synapse adds a unique index to the `state_group_edges` table, in order to prevent accidentally introducing duplicate information (for example, because a database backup was restored multiple times). If your Synapse database already has duplicate rows in this table, this could fail with an error and require manual remediation. Additionally, the signature of the `check_event_for_spam` module callback has changed. The previous signature has been deprecated and remains working for now. Module authors should update their modules to use the new signature where possible. See [the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/docs/upgrade.md#upgrading-to-v1600) for more details. Features -------- - Add an option allowing users to use their password to reauthenticate for privileged actions even though password login is disabled. ([\#12883](https://github.com/matrix-org/synapse/issues/12883)) Bugfixes -------- - Explicitly close `ijson` coroutines once we are done with them, instead of leaving the garbage collector to close them. ([\#12875](https://github.com/matrix-org/synapse/issues/12875)) Internal Changes ---------------- - Improve URL previews by not including the content of media tags in the generated description. ([\#12887](https://github.com/matrix-org/synapse/issues/12887))
| * Add an option allowing users to use their password to reauthenticate even ↵reivilibre2022-05-272-1/+6
| | | | | | | | though password authentication is disabled. (#12883)
* | Remove unstable APIs for /hierarchy. (#12851)Patrick Cloke2022-05-261-3/+3
| | | | | | | | Removes the unstable endpoint as well as a duplicated field which was modified during stabilization.
* | Remove user-visible groups/communities code (#12553)Patrick Cloke2022-05-252-29/+0
| | | | | | | | | | | | | | | | | | Makes it so that groups/communities no longer exist from a user-POV. E.g. we remove: * All API endpoints (including Client-Server, Server-Server, and admin). * Documented configuration options (and the experimental flag, which is now unused). * Special handling during room upgrades. * The `groups` section of the `/sync` response.
* | Add the `batch_send` endpoint to generic workers (#12868)Nick Mills-Barrett2022-05-251-0/+1
| |
* | Add the `/account/whoami` endpoint to generic workers (#12866)Nick Mills-Barrett2022-05-251-0/+1
| |
* | Fix incorrect worker-allowed path in documentation (#12867)Nick Mills-Barrett2022-05-251-3/+0
| |
* | Fix typos in documentation (#12863)Dirk Klimpel2022-05-253-3/+3
|/
* contributing_guide.md: fix link to DCORichard van der Hoff2022-05-241-2/+2
|
* Uniformize spam-checker API, part 2: check_event_for_spam (#12808)David Teller2022-05-232-10/+46
| | | Signed-off-by: David Teller <davidt@element.io>
* add SpamChecker callback for silently dropping inbound federated events (#12744)Jess Porter2022-05-231-0/+18
| | | Signed-off-by: jesopo <github@lolnerd.net>
* Add detail to `cache_autotuning` config option documentation (#12776)Shay2022-05-191-4/+9
|
* Update configuration manual to document size-related suffixes (#12777)Shay2022-05-191-0/+8
|
* Add a unique index to `state_group_edges` to prevent duplicates being ↵reivilibre2022-05-191-0/+90
| | | | accidentally introduced and the consequential impact to performance. (#12687)
* Add missing user directory search endpoint to the generic worker ↵Sami Olmari2022-05-191-0/+10
| | | | | | documentation (#12773) Signed-off-by: Sami Olmari <sami@olmari.fi>
* openid.md: fix some linksRichard van der Hoff2022-05-191-9/+9
| | | docbook doesn't auto-linkify links
* Fix federation in demo scripts. (#12783)Patrick Cloke2022-05-181-4/+5
|
* Fix YAML parsing error in `url_preview_accept_language` (#12785)Andrew Morgan2022-05-181-6/+6
|
* Add documentation for cancellation of request processing (#12761)Sean Quah2022-05-182-0/+393
| | | | Signed-off-by: Sean Quah <seanq@matrix.org>
* Switch the 'Configuration' link in the docs homepage to the config manual ↵Andrew Morgan2022-05-181-3/+3
| | | | (#12748)
* Add some documentation around the `rc_invites` option to the config docs ↵Andrew Morgan2022-05-181-0/+14
| | | | (#12759)
* Suggest using docker when testing against postgres (#12765)David Robertson2022-05-171-3/+28
| | | Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Fix typo in name of 'run_background_tasks_on' option in config manual (#12749)Andrew Morgan2022-05-161-1/+1
|
* Fix typo in listener config (#12742)Dirk Klimpel2022-05-162-3/+3
|
* Add config flags to allow for cache auto-tuning (#12701)Shay2022-05-132-2/+33
|
* Update issuer URL in example OIDC Keycloak config (#12727)Niklas2022-05-131-1/+1
| | | | | | | * Update openid.md Newer versions of keycloak returning a 404 when using the `/auth` prefix. Related: https://github.com/matrix-org/synapse/issues/12714
* add default_power_level_content_override config option. (#12618)Andy Balaam2022-05-122-0/+60
| | | Co-authored-by: Matthew Hodgson <matthew@matrix.org>
* Fix reference to the wrong symbol in the media admin api docs (#12715)Andrew Morgan2022-05-121-1/+1
|
* Reload cache factors from disk on SIGHUP (#12673)David Robertson2022-05-112-0/+23
|
* Add the `update_user_directory_from_worker` configuration option ↵reivilibre2022-05-102-12/+39
| | | | | (superseding `update_user_directory`) to allow a generic worker to be designated as the worker to update the user directory. (#12654) Co-authored-by: Shay <hillerys@element.io>
* Update `replication.md` with info on TCP module structure (#12621)Shay2022-05-091-0/+5
|
* Update SQL statements in docs for Synapse Admins (#12536)Dirk Klimpel2022-05-091-70/+121
|
* Fix docs on how to run specific Complement tests after recent ↵Eric Eastwood2022-05-091-2/+2
| | | | `complement.sh` change (#12664)
* Add the `notify_appservices_from_worker` configuration option (superseding ↵reivilibre2022-05-062-0/+47
| | | | `notify_appservices`) to allow a generic worker to be designated as the worker to send traffic to Application Services. (#12452)
* Add `mau_appservice_trial_days` config (#12619)Will Hunt2022-05-042-0/+21
| | | | | | | | | | | | | | | | | | | | | * Add mau_appservice_trial_days * Add a test * Tweaks * changelog * Ensure we sync after the delay * Fix types * Add config statement * Fix test * Reinstate logging that got removed * Fix feature name
* Disable device name lookup over federation by default (#12616)Andrew Morgan2022-05-043-7/+18
|
* Remove unstable/unspecced login types. (#12597)Patrick Cloke2022-05-041-3/+0
| | | | | | * `m.login.jwt`, which was never specced and has been deprecated since Synapse 1.16.0. (`org.matrix.login.jwt` can be used instead.) * `uk.half-shot.msc2778.login.application_service`, which was stabilized as part of the Matrix spec v1.2 release.
* Improve logging for cancelled requests (#12587)Sean Quah2022-05-041-1/+1
| | | | | | | Don't log stack traces for cancelled requests and use a custom HTTP status code of 499. Signed-off-by: Sean Quah <seanq@element.io>
* Remove special-case for `twisted` logger (#12589)Richard van der Hoff2022-04-291-7/+0
| | | | | | | | | | | | | | | This was originally added when we first added a `MemoryHandler` to the default log config back in https://github.com/matrix-org/synapse/pull/8040, to ensure that we didn't explode with an infinite loop if there was an error formatting the logs. Since then, we made additional improvements to logging which make this workaround redundant. In particular: * we no longer attempt to log un-UTF8-decodable byte sequences, which were the most likely cause of an error in the first place. * https://github.com/matrix-org/synapse/pull/8268 ensures that in the unlikely case that there *is* an error, it won't cause an infinite loop.
* Add option to enable token registration without requiring 3pids (#12526)Will Hunt2022-04-271-0/+6
|
* Add a table of contents to config manual (#12527)Shay2022-04-251-2/+44
| | | * Update config_documentation.md
* Correct typo in user_admin_api.md device deletion JSON (#12533)Sami Olmari2022-04-251-1/+1
| | | | Signed-off-by: Sami Olmari <sami@olmari.fi>
* Add HAProxy delegation example to docs (#12501)villepeh2022-04-251-0/+22
| | | Signed-off-by: Ville Petteri Huh
* Add some example configurations for worker (#12492)Dirk Klimpel2022-04-254-24/+55
| | | Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
* turn-howto: fix some linksRichard van der Hoff2022-04-221-2/+2
|
* Recommend poetry in docs (#12475)David Robertson2022-04-203-36/+283
| | | | | | | | | | | * Recommend poetry in docs - readme - contributor guide - upgrade notes - new dev cheat sheet for poetry Co-authored-by: Shay <hillerys@element.io> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Merge branch 'master' into developOlivier Wilkinson (reivilibre)2022-04-191-1/+1
|\
| * fix typo in upgrade notesRichard van der Hoff2022-04-191-1/+1
| |
* | Add a manual documenting config file options (#12368)Shay2022-04-182-0/+3413
| |
* | Update documentation to reflect that `run_background_tasks_on` is no longer ↵reivilibre2022-04-141-4/+4
| | | | | | | | | | | | | | | | | | | | | | experimental. (#12451) * Background workers aren't experimental anymore * Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> * Stream writers aren't experimental either
* | Replace `federation_reader` with `generic_worker` in docs (#12457)Dirk Klimpel2022-04-144-24/+22
| |
* | Reintroduce the lint targets in the linter script (#12455)David Robertson2022-04-141-39/+15
| |
* | docs: Don't render the table of contents on the print page (#12340)Andrew Morgan2022-04-131-0/+14
| |
* | Merge branch 'release-v1.57' into developErik Johnston2022-04-126-8/+9445
|\|
| * Update UPGRADE notes to include more details about v1.57 upgrade failure ↵Richard van der Hoff2022-04-121-8/+47
| | | | | | | | mode (#12448)
| * Split changelogs by year v1.57.0rc1Erik Johnston2022-04-125-0/+9398
| |
* | Disable groups/communities by default. (#12344)Patrick Cloke2022-04-121-0/+7
|/ | | | This disables the endpoints (and sync response fields) for groups/communities by default.
* Stop maintaining a list of lint targets in `lint.sh` (#12420)David Robertson2022-04-081-5/+3
|
* Clarify that we mark as outliers because we don't have any state for them ↵Eric Eastwood2022-04-061-1/+2
| | | | | (#12345) As discussed at https://github.com/matrix-org/synapse/pull/12179#discussion_r837263852
* Remove docs for converting a legacy structured logging config. (#12392)Patrick Cloke2022-04-062-81/+2
| | | And update the upgrade notes to point at old versions of the documentation.
* Merge branch 'master' into developSean Quah2022-04-051-6/+5
|\
| * Move warning of open registration to v1.56 upgrade notes (#12322)Andrew Morgan2022-03-291-6/+5
| |
* | Allow specifying the Postgres database's port when running unit tests with ↵reivilibre2022-04-051-3/+11
| | | | | | | | Postgres. (#12376)
* | Update broken link in `workers.md` (#12369)Shay2022-04-041-1/+1
| |
* | Use a sequence to generate AS transaction IDs, drop `last_txn` AS state (#12209)Nick Mills-Barrett2022-04-011-0/+13
| | | | | | | | | | | | | | | | Switching to a sequence means there's no need to track `last_txn` on the AS state table to generate new TXN IDs. This also means that there is no longer contention between the AS scheduler and AS handler on updates to the `application_services_state` table, which will prevent serialization errors during the complete AS txn transaction.
* | Add a module callback to react to account data changes (#12327)Brendan Abolivier2022-04-013-1/+108
| | | | | | | | Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* | Add a callback to react to 3PID associations (#12302)Brendan Abolivier2022-03-311-0/+18
| |
* | Remove `dockerfile-pgtests` (#12336)David Robertson2022-03-311-21/+0
| |
* | Flesh out documentation for running SyTest against Synapse, including use of ↵reivilibre2022-03-301-1/+7
| | | | | | | | | | Postgres and worker mode. (#12271) Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* | Add a configuration to exclude rooms from sync response (#12310)Brendan Abolivier2022-03-301-0/+9
|/
* HAProxy guide update (#12279)villepeh2022-03-281-2/+2
| | | HAproxy reverse proxy guide update to stop sending IPv4-mapped address to HS.
* Add restrictions by default to open registration in Synapse (#12091)Shay2022-03-252-1/+15
|
* Authentik OpenID minor doc update (#12275)IronTooch2022-03-251-1/+3
|
* Mention the new behaviour on unsafe database locale in the upgrade notes ↵Brendan Abolivier2022-03-251-0/+7
| | | | | (#12288) Co-authored-by: Shay <hillerys@element.io>
* Refuse to start if DB has an unsafe locale (#12262)Shay2022-03-232-3/+10
|
* Remove mutual_rooms `update_user_directory` check, and add extra ↵Jonathan de Jong2022-03-231-1/+10
| | | | | documentation (#12038) Resolves #10339
* Sync more worker regexes in the documentation. (#12243)Patrick Cloke2022-03-181-16/+14
|
* Correct `check_username_for_spam` annotations and docs (#12246)David Robertson2022-03-181-4/+6
| | | | | | | * Formally type the UserProfile in user searches * export UserProfile in synapse.module_api * Update docs Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Deprecate the groups/communities endpoints and add an experimental ↵Patrick Cloke2022-03-121-0/+14
| | | | configuration flag. (#12200)
* Add config settings for background update parameters (#11980)Shay2022-03-111-0/+32
|
* Implement a Jinja2 filter to extract localparts from email addresses (#12212)Brendan Abolivier2022-03-112-1/+9
|
* Update the SSO username picker template to comply with SIWA guidelines (#12210)Brendan Abolivier2022-03-112-4/+12
| | | Fixes https://github.com/matrix-org/synapse/issues/12205
* Note that contributors can sign off privately (#12204)Andrew Morgan2022-03-111-0/+11
| | | Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Document that most streams can only have a single writer. (#12196)~creme2022-03-101-14/+17
| | | | This includes the `typing`, `to_device`, `account_data`, `receipts`, and `presence` streams (really anything except the `events` stream).
* Remove workaround introduced in Synapse v1.50.0rc1 for Mjolnir ↵reivilibre2022-03-101-0/+8
| | | | compatibility. Breaks compatibility with Mjolnir v1.3.1 and earlier. (#11700)
* Updates to the Room DAG concepts development document (#12179)Richard van der Hoff2022-03-101-18/+53
| | | | Some stuff that came up while we were talking about #12173.
* Add third_party module callbacks to check if a user can delete a room and ↵Will Hunt2022-03-091-0/+43
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | deactivate a user (#12028) * Add check_can_deactivate_user * Add check_can_shutdown_rooms * Documentation * callbacks, not functions * Various suggested tweaks * Add tests for test_check_can_shutdown_room and test_check_can_deactivate_user * Update check_can_deactivate_user to not take a Requester * Fix check_can_shutdown_room docs * Renegade and use `by_admin` instead of `admin_user_id` * fix lint * Update docs/modules/third_party_rules_callbacks.md Co-authored-by: Brendan Abolivier <babolivier@matrix.org> * Update docs/modules/third_party_rules_callbacks.md Co-authored-by: Brendan Abolivier <babolivier@matrix.org> * Update docs/modules/third_party_rules_callbacks.md Co-authored-by: Brendan Abolivier <babolivier@matrix.org> * Update docs/modules/third_party_rules_callbacks.md Co-authored-by: Brendan Abolivier <babolivier@matrix.org> Co-authored-by: Brendan Abolivier <babolivier@matrix.org>
* Clean-up demo scripts & documentation (#12143)Patrick Cloke2022-03-083-1/+44
| | | | | | | | | * Rewrites the demo documentation to be clearer, accurate, and moves it to our documentation tree. * Improvements to the demo scripts: * `clean.sh` now runs `stop.sh` first to avoid zombie processes. * Uses more modern Synapse configuration (and removes some obsolete configuration). * Consistently use the HTTP ports for server name, etc. * Remove the `demo/etc` directory and place everything into the `demo/808x` directories.
* Move synctl into `synapse._scripts` and expose as an entrypoint (#12140)David Robertson2022-03-043-7/+29
|
* Add suffices to scripts in scripts-dev (#12137)David Robertson2022-03-021-1/+1
| | | | | | | | | * Rename scripts-dev to have suffices * Update references to `scripts-dev` * Changelog * These scripts don't pass mypy
* Enable complexity checking in complexity checking docs example (#11998)Andrew Morgan2022-03-021-9/+10
|
* Move scripts directory inside synapse, exposing as setuptools entry_points ↵David Robertson2022-03-022-4/+4
| | | | | | | | | | | | (#12118) * Two scripts are basically entry_points already * Move and rename scripts/* to synapse/_scripts/*.py * Delete sync_room_to_group.pl * Expose entry points in setup.py * Update linter script and config * Fixup scripts & docs mentioning scripts that moved Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* Add module callbacks called for reacting to deactivation status change and ↵Brendan Abolivier2022-03-011-0/+56
| | | | profile update (#12062)
* Remove the unstable `/spaces` endpoint. (#12073)Patrick Cloke2022-02-281-2/+0
| | | | | | | | ...and various code supporting it. The /spaces endpoint was from an old version of MSC2946 and included both a Client-Server and Server-Server API. Note that the unstable /hierarchy endpoint (from the final version of MSC2946) is not yet removed.
* Add documentation for missing worker types. (#11599)Patrick Cloke2022-02-231-14/+76
| | | And clean-up the endpoints which should be routed to workers.
* Remove `HomeServer.get_datastore()` (#12031)Richard van der Hoff2022-02-231-1/+1
| | | | | | | The presence of this method was confusing, and mostly present for backwards compatibility. Let's get rid of it. Part of #11733
* Use room version 9 as the default room version (per MSC3589). (#12058)Patrick Cloke2022-02-221-1/+1
|
* Merge remote-tracking branch 'origin/master' into developErik Johnston2022-02-221-1/+1
|\
| * Recommend upgrading treq alongside twisted (#11943)Brendan Abolivier2022-02-091-1/+1
| |
* | Document why auth providers aren't validated in the admin API. (#12004)Patrick Cloke2022-02-181-1/+2
| | | | | | | | Since it is reasonable to give a future or past auth provider, which might not be in the current configuration.
* | Allow modules to set a display name on registration (#12009)Brendan Abolivier2022-02-171-4/+31
| | | | | | Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* | Remove support for the legacy structured logging configuration. (#12008)Patrick Cloke2022-02-172-8/+15
| |
* | Explain the meaning of spam checker callbacks' return values (#12003)David Robertson2022-02-161-13/+27
| | | | | | Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* | Note when unstable MSC3283 prefixes will be removed (#11989)Andrew Morgan2022-02-141-1/+1
| |
* | remove empty file, reword/rename newsfragment, and add line to upgrade docH. Shay2022-02-141-0/+1
| |
* | Enable cache time-based expiry by default (#11849)Shay2022-02-112-4/+16
| |
* | Remove deprecated user_may_create_room_with_invites callback (#11950)Brendan Abolivier2022-02-111-10/+19
| | | | | | Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* | Support the stable API endpoint for MSC3283: new settings in `/capabilities` ↵Dirk Klimpel2022-02-111-0/+19
| | | | | | | | endpoint (#11933)
* | Basic documentation for the release cycle. (#11954)Patrick Cloke2022-02-102-0/+38
| |
* | Fix example for structured logging. (#11946)Brad Jones2022-02-091-1/+1
| | | | | | The StreamHandler takes a stream parameter, not location.
* | Merge branch 'master' into developBrendan Abolivier2022-02-081-0/+12
|\|
| * Fix wordingBrendan Abolivier2022-02-081-6/+7
| |
| * Add words about the Twisted security fix v1.52.0Brendan Abolivier2022-02-081-0/+11
| |
* | Add a callback to allow modules to deny 3PID (#11854)Brendan Abolivier2022-02-081-0/+19
| | | | | | | | | | Part of the Tchap Synapse mainlining. This allows modules to implement extra logic to figure out whether a given 3PID can be added to the local homeserver. In the Tchap use case, this will allow a Synapse module to interface with the custom endpoint /internal_info.
* | Clarify that users' media are also preview images (#11862)Dirk Klimpel2022-02-042-1/+11
| |
* | Stabilise MSC3231 (Token Based Registration) (#11867)Jonathan de Jong2022-02-043-2/+17
| |
* | Delete MSC1711_certificates_FAQ.md (#11907)Richard van der Hoff2022-02-043-321/+2
| | | | | | This document isn't really relevant any more, and its existence is more confusing than helpful.
* | Remove support for the webclient listener. (#11895)Patrick Cloke2022-02-031-0/+13
| | | | | | Also remove support for non-HTTP(S) web_client_location.
* | Fix typo: unpind -> unbind (#11859)Christian Paul2022-02-031-1/+1
| | | | | | Co-authored-by: reivilibre <olivier@librepush.net>
* | Add a ratelimiter for 3pid invite (#11892)Brendan Abolivier2022-02-031-0/+7
|/
* Consolidate the `access_token` information in the admin api (#11861)Dirk Klimpel2022-01-319-95/+29
| | | Co-authored-by: reivilibre <olivier@librepush.net>
* Remove not needed old table of contents in documentation (#11860)Dirk Klimpel2022-01-313-53/+0
|
* Configurable limits on avatars (#11846)Brendan Abolivier2022-01-281-0/+14
| | | | | | Only allow files which file size and content types match configured limits to be set as avatar. Most of the inspiration from the non-test code comes from matrix-org/synapse-dinsic#19
* Fix some indentation inconsistencies in the sample config (modules) (#11838)Dirk Klimpel2022-01-271-5/+5
|
* Update installation docs to indicate that we support Python 3.10 (#11820)Shay2022-01-261-1/+1
|
* Add a module callback to set username at registration (#11790)Brendan Abolivier2022-01-261-0/+62
| | | | | | This is in the context of mainlining the Tchap fork of Synapse. Currently in Tchap usernames are derived from the user's email address (extracted from the UIA results, more specifically the m.login.email.identity step). This change also exports the check_username method from the registration handler as part of the module API, so that a module can check if the username it's trying to generate is correct and doesn't conflict with an existing one, and fallback gracefully if not. Co-authored-by: David Robertson <davidr@element.io>
* Add a config flag to inhibit `M_USER_IN_USE` during registration (#11743)Brendan Abolivier2022-01-261-0/+10
| | | | | | | This is mostly motivated by the tchap use case, where usernames are automatically generated from the user's email address (in a way that allows figuring out the email address from the username). Therefore, it's an issue if we respond to requests on /register and /register/available with M_USER_IN_USE, because it can potentially leak email addresses (which include the user's real name and place of work). This commit adds a flag to inhibit the M_USER_IN_USE errors that are raised both by /register/available, and when providing a username early into the registration process. This error will still be raised if the user completes the registration process but the username conflicts. This is particularly useful when using modules (https://github.com/matrix-org/synapse/pull/11790 adds a module callback to set the username of users at registration) or SSO, since they can ensure the username is unique. More context is available in the PR that introduced this behaviour to synapse-dinsic: matrix-org/synapse-dinsic#48 - as well as the issue in the matrix-dinsic repo: matrix-org/matrix-dinsic#476
* Add admin API to get a list of federated rooms (#11658)Dirk Klimpel2022-01-251-0/+60
|
* Minor updates, and docs, for schema delta files (#11823)Richard van der Hoff2022-01-251-0/+54
| | | | | | | | | * Make functions in python deltas optional It's annoying to always have to write stubs for these. * Documentation for delta files * changelog
* Docs: add missing PR submission process how-tos (#11821)Forest Johnson2022-01-251-1/+2
| | | | | | | * Docs: add missing PR submission process how-tos The documentation says that in order to submit a pull request you have to run the linter and links to [Run the linters](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#run-the-linters). IMO "Run the linters" should explain that development dependencies are a pre-requisite. I also included `pip install wheel` which I had to run inside my virtual environment on ubuntu before I `pip install -e ".[all,dev]"` would succeed.
* Add admin API to reset connection timeouts for remote server (#11639)Dirk Klimpel2022-01-251-1/+39
| | | * Fix get federation status of destination if no error occured
* Remove account data (including client config, push rules and ignored users) ↵reivilibre2022-01-241-1/+5
| | | | | upon user deactivation. (#11621) Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Drop support for and remove references to EOL Python 3.6 (#11683)Shay2022-01-211-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * remove reference in comments to python3.6 * upgrade tox python env in script * bump python version in example for completeness * upgrade python version requirement in setup doc * upgrade necessary python version in __init__.py * upgrade python version in setup.py * newsfragment * drops refs to bionic and replace with focal * bump refs to postgres 9.6 to 10 * fix hanging ci * try installing tzdata first * revert change made in b979f336 * ignore new random mypy error while debugging other error * fix lint error for temporary workaround * revert change to install list * try passing env var * export debian frontend var? * move line and add comment * bump pillow dependency * bump lxml depenency * install libjpeg-dev for pillow * bump automat version to one compatible with py3.8 * add libwebp for pillow * bump twisted trunk python version * change suffix of newsfragment * remove redundant python 3.7 checks * lint
* installation.md: drop python 3.6 support (#11781)Richard van der Hoff2022-01-201-1/+1
| | | #11595 dropped support for python 3.6, but forgot to update this doc.
* Add deprecation warnings for `webclient` listener and non-HTTP(S) ↵Patrick Cloke2022-01-202-9/+12
| | | | | | | `web_client_location`. (#11774) This changes the behaviour of the root endpoint to redirect directly to the configuration of `web_client_location` if it is given an HTTP(S) URL.
* Fix preview of imgur and Tenor URLs. (#11669)Philippe Daouadi2022-01-181-1/+6
| | | | | | By scraping Open Graph information from the HTML even when an autodiscovery endpoint is found. The results are then combined to capture as much information as possible from the page.
* Warn against using Let's Encrypt certs for encrypted TURN (#11686)AndrewFerr2022-01-171-0/+16
| | | | | | | | | * Warn against using Let's Encrypt certs for encrypted TURN This helps to avoid client-side issues: * https://github.com/vector-im/element-android/issues/1533 * https://github.com/vector-im/element-ios/issues/2712 Signed-off-by: Andrew Ferrazzutti <fair@miscworks.net>
* Fix up docs for `track_puppeted_user_ips` (again) (#11757)Richard van der Hoff2022-01-171-4/+12
| | | Fixes #11741
* Update documentation for configuring facebook login (#11755)Richard van der Hoff2022-01-172-15/+19
| | | ... and a minor thinko fix in the sample config.
* Remove the 'password_hash' from the Users Admin API endpoint response ↵Andrew Morgan2022-01-141-4/+5
| | | | dictionary (#11576)
* Fix sample_config.yaml in regards track_puppeted_user_ips (#11749)Jason Robinson2022-01-141-5/+6
| | | | | | | * Fix sample_config.yaml in regards track_puppeted_user_ips Closes #11741 Signed-off-by: Jason Robinson <jasonr@matrix.org>
* update room spec url in config files (#11739)qwertyforce2022-01-131-1/+1
| | | | | | | * change spec url in config files * Create 11739.txt * .txt -> .doc
* Mention python3-venv and libpq-dev dependencies in contribution guide (#11740)Andy Balaam2022-01-131-1/+3
|
* Allow tracking puppeted users for MAU (#11561)Jason Robinson2022-01-121-0/+6
| | | | | | | | | | | | | | | Currently when puppeting another user, the user doing the puppeting is tracked for client IPs and MAU (if configured). When tracking MAU is important, it becomes necessary to be possible to also track the client IPs and MAU of puppeted users. As an example a client that manages user creation and creation of tokens via the Synapse admin API, passing those tokens for the client to use. This PR adds optional configuration to enable tracking of puppeted users into monthly active users. The default behaviour stays the same. Signed-off-by: Jason Robinson <jasonr@matrix.org>
* Fix documentation of supported PostgreSQL version (#11725)haslersn2022-01-121-1/+1
| | | Signed-off-by: Sebastian Hasler <sebastian.hasler@stuvus.uni-stuttgart.de>
* Document the `SYNAPSE_TEST_PERSIST_SQLITE_DB` unit test env var (#11715)Andrew Morgan2022-01-101-0/+21
|
* Add support removal notice to the upgrade notesOlivier Wilkinson (reivilibre)2022-01-051-0/+11
|
* Fix link from generated configuration file to documentation (#11678)Philipp Matthias Schäfer2022-01-051-1/+1
| | | | Co-authored-by: reivilibre <olivier@librepush.net> Co-authored-by: reivilibre <oliverw@matrix.org>
* Add admin API to get users' account data (#11664)Dirk Klimpel2022-01-051-0/+75
| | | Co-authored-by: reivilibre <olivier@librepush.net>
* Clarify SSO mapping provider documentation by writing `def` or `async def` ↵reivilibre2022-01-051-12/+12
| | | | before the names of methods, as appropriate. (#11681)
* Correct Synapse install command for FreeBSD. (#11267)Donny Johnson2022-01-051-1/+1
| | | Co-authored-by: reivilibre <olivier@librepush.net>
* update ngnix reverse-proxy example (#11680)Richard van der Hoff2022-01-041-1/+1
| | | this should not be a case-insensitive match.
* Include the topic event in the prejoin state, per MSC3173. (#11666)Patrick Cloke2022-01-041-0/+1
| | | | Invites and knocks will now include the topic in the stripped state send to clients before joining the room.
* Add details for how to set up TURN behind NAT (#11553)AndrewFerr2021-12-231-15/+52
| | | | Signed-off-by: Andrew Ferrazzutti <fair@miscworks.net>
* Merge branch 'master' into developRichard van der Hoff2021-12-211-2/+2
|\
| * Add notes about dropping support for Python 3.6 and Postgres 9.6. v1.49.1Richard van der Hoff2021-12-211-2/+2
| |
* | Document the usage of refresh tokens. (#11427)reivilibre2021-12-082-0/+140
|/ | | Co-authored-by: David Robertson <davidr@element.io>
* Stabilise support for MSC2918 refresh tokens as they have now been merged ↵reivilibre2021-12-061-0/+38
| | | | into the Matrix specification. (#11435)
* Add admin API to get some information about federation status (#11407)Dirk Klimpel2021-12-062-0/+115
|
* Update backward extremity docs to make it clear that it does not indicate ↵Eric Eastwood2021-12-031-9/+7
| | | | | | | whether we have fetched an events' `prev_events` (#11469) Spawning from https://github.com/matrix-org/synapse/pull/9445#discussion_r758958181 Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* Minor cleanup on recently ported doc pages (#11466)Shay2021-12-023-43/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * move wiki pages to synapse/docs and add a few titles where necessary * update SUMMARY.md with added pages * add changelog * move incorrectly located newsfragment * update changelog number * snake case added files and update summary.md accordingly * update issue/pr links * update relative links to docs * update changelog to indicate that we moved wiki pages to the docs and state reasoning * requested changes to admin_faq.md * requested changes to database_maintenance_tools.md * requested changes to understanding_synapse_through_graphana_graphs.md * add changelog * fix leftover merge errata * fix unwanted changes from merge * use two spaces between entries * outdent code blocks
* Port wiki pages to documentation website (#11402)Shay2021-12-017-0/+465
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * move wiki pages to synapse/docs and add a few titles where necessary * update SUMMARY.md with added pages * add changelog * move incorrectly located newsfragment * update changelog number * snake case added files and update summary.md accordingly * update issue/pr links * update relative links to docs * update changelog to indicate that we moved wiki pages to the docs and state reasoning * revert unintentional change to CHANGES.md * add link Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> * Update CHANGES.md Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* Link background update controller docs to summary (#11475)Brendan Abolivier2021-12-011-0/+1
|
* Update openid.mdRichard van der Hoff2021-12-011-1/+1
| | | fix header level
* Remove mention of OIDC certification from Dex (#11470)Etienne Dysli Metref2021-12-011-1/+1
| | | | | | | Dex isn't yet [1,2] a certified OpenID Provider implementation. As of today, it's not on the list maintained by the OpenID Foundation. [3] [1] https://github.com/dexidp/dex/issues/42 [2] https://github.com/dexidp/dex/issues/262 [3] https://openid.net/certification/
* Add a note about huge pages to our Postgres doc (#11467)Shay2021-11-301-0/+3
| | | | | * Add note to postgres doc about hugepages * Newsfragment
* Improved push typing (#11409)Marcus2021-11-301-0/+5
| | | Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Support the stable /hierarchy endpoint from MSC2946 (#11329)Patrick Cloke2021-11-291-2/+2
| | | | | | This also makes additional updates where the implementation had drifted from the approved MSC. Unstable endpoints will be removed at a later data.
* Make background updates controllable via a plugin (#11306)Erik Johnston2021-11-292-6/+77
| | | Co-authored-by: Brendan Abolivier <babolivier@matrix.org>