summary refs log tree commit diff
path: root/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Version picker added for v1.97 docs github/release-v1.97 release-v1.97Action Bot2023-12-115-1/+224
|
* Update admin user API return types in docs. (#16654)Michael Weimann2023-11-171-4/+15
|
* Add an Admin API to temporarily grant the ability to update an existing ↵David Robertson2023-11-151-0/+37
| | | | cross-signing key without UIA (#16634)
* Asynchronous Uploads (#15503)Sumner Evans2023-11-151-0/+34
| | | Support asynchronous uploads as defined in MSC2246.
* Add links to pre-1.0 changelog issue/PR references. (#16638)Patrick Cloke2023-11-151-807/+807
|
* Improve documentation for ↵Will Hunt2023-11-141-1/+2
| | | | `/_synapse/admin/v1/rooms/<room_id>/timestamp_to_event` (#16631)
* Fix outbound_federation_restricted_to docs & note when added (#16628)David Robertson2023-11-131-0/+3
|
* Use dbname instead of database for Postgres config. (#16618)Patrick Cloke2023-11-092-4/+4
|
* Add new module API for adding custom fields to events `unsigned` section ↵Erik Johnston2023-10-272-1/+34
| | | | (#16549)
* Add a new module API to update user presence state. (#16544)Patrick Cloke2023-10-261-0/+7
| | | | | | | | | | This adds a module API which allows a module to update a user's presence state/status message. This is useful for controlling presence from an external system. To fully control presence from the module the presence.enabled config parameter gains a new state of "untracked" which disables internal tracking of presence changes via user actions, etc. Only updates from the module will be persisted and sent down sync properly).
* Pin the recommended poetry version in contributors' guide (#16550)David Robertson2023-10-251-1/+1
|
* Rework alias and public room list rules docs (#16541)David Robertson2023-10-241-34/+132
|
* Fix bug where a new writer advances their token too quickly (#16473)Erik Johnston2023-10-231-3/+10
| | | | | | | | | | | | | | | | | | | * Fix bug where a new writer advances their token too quickly When starting a new writer (for e.g. persisting events), the `MultiWriterIdGenerator` doesn't have a minimum token for it as there are no rows matching that new writer in the DB. This results in the the first stream ID it acquired being announced as persisted *before* it actually finishes persisting, if another writer gets and persists a subsequent stream ID. This is due to the logic of setting the minimum persisted position to the minimum known position of across all writers, and the new writer starts off not being considered. * Fix sending out POSITIONs when our token advances without update Broke in #14820 * For replication HTTP requests, only wait for minimal position
* Mention how to redirect the Jaeger traces to a specific Jaeger instance (#16531)Marcel2023-10-231-0/+5
|
* Clarify presence router docs. (#16529)Patrick Cloke2023-10-201-3/+11
|
* Fix typo in useful_sql_for_admins.md (#16477)Laurence Gill2023-10-121-1/+1
|
* Add documentation on background updates. (#16420)Patrick Cloke2023-10-061-0/+61
|
* Add note to 'federation_domain_whitelist' option (#16416)Erik Johnston2023-10-031-0/+5
|
* Clean-up old release notes (#16418)Patrick Cloke2023-10-022-134/+135
| | | | Fixes some broken formatting from the reStructuedText to Markdown conversion and fixes some typos.
* Remove Python version from `/_synapse/admin/v1/server_version` (#16380)MomentQYC2023-10-021-4/+6
| | | | There's no reason to expose the full Python version over what is frequently a public API.
* Remove warnings from the docs about using message retention. (#16382)Patrick Cloke2023-09-282-7/+3
| | | | | There are no known bugs in the message retention code, but it is possible that there still exists race conditions. Additional fixes will be made as reported.
* Add documentation about the user directory search algorithm (#16320)Patrick Cloke2023-09-261-26/+110
|
* Add developer documentation concerning gradual schema migrations with column ↵reivilibre2023-09-251-0/+157
| | | | | | | alterations. (#15691) Co-authored-by: Eric Eastwood <erice@element.io>
* Fix-up deactivated notes in docs. (#16355)Patrick Cloke2023-09-191-1/+1
|
* Use string for federation_client_minimum_tls_version documentation examples ↵Jan Christian Grünhage2023-09-191-4/+4
| | | | (#16353)
* Filter locked users in the admin API (#16328)Hanadi2023-09-181-5/+12
| | | | Co-authored-by: Hanadi Tamimi <hanadi.tamimi@sdui.de>
* Add automatic purge after all users forget a room (#15488)Mathieu Velten2023-09-151-0/+11
| | | | | | Also add restore of purge/shutdown rooms after a synapse restart. Co-authored-by: Eric Eastwood <erice@matrix.org> Co-authored-by: Erik Johnston <erikj@matrix.org>
* docs: Link to the Alpine Linux community package for Synapse (#16304)65432023-09-141-0/+8
|
* Fix-up incorrect spellings in docs. (#16282)Patrick Cloke2023-09-0817-119/+119
|
* Add `/notifications` endpoint to workers (#16265)Erik Johnston2023-09-071-0/+1
|
* Handle "registration_enabled" parameter for CAS (#16262)Aurélien Grimpard2023-09-061-0/+7
| | | | Similar to OIDC, CAS providers can now disable registration such that only existing users are able to login via SSO.
* Add the ability to use `G` (GiB) and `T` (TiB) suffixes in configuration ↵reivilibre2023-09-061-1/+3
| | | | | | | | | | | | | options that refer to numbers of bytes. (#16219) * Add more suffixes to `parse_size` * Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> --------- Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
* Bump minimum supported Rust version to 1.61.0 (#16248)Erik Johnston2023-09-051-0/+8
|
* Add last_seen_ts to the admin users API (#16218)Mathieu Velten2023-09-041-0/+2
|
* Add warnings about MSC3861 on certain APIs. (#16168)Will Hunt2023-08-254-1/+15
|
* Document `exclude_rooms_fom_sync` configuration option (#16178)Shay2023-08-241-0/+13
|
* Add configuration setting for CAS protocol version (#15816)Aurélien Grimpard2023-08-241-0/+2
|
* Update URLs to matrix.org blog categories. (#16008)Amirreza Aflakparast2023-08-241-2/+2
|
* Add `client_secret_path` as alternative for `client_secret` for OIDC config ↵Maximilian Bosch2023-08-211-0/+8
| | | | (#16030)
* Allow filtering for admins in the list accounts admin API (#16114)Alexander Fechler2023-08-181-0/+2
|
* Add link explaining ELK stack to structured_logging.md (#16091)axel simon2023-08-161-1/+1
|
* Allow customizing IdP name and icon for SAML and CAS (#16094)Gabriel Rodríguez2023-08-111-1/+21
|
* Implements admin API to lock an user (MSC3939) (#15870)Mathieu Velten2023-08-102-0/+3
|
* Add notes describing Synapse's streams (#16015)David Robertson2023-08-072-0/+158
| | | | Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Move support for application service query parameter authorization behind a ↵Shay2023-08-032-1/+29
| | | | configuration option (#16017)
* Allow config of the backoff algorithm for the federation client. (#15754)Mathieu Velten2023-08-031-0/+11
| | | | | | | | | | | Adds three new configuration variables: * destination_min_retry_interval is identical to before (10mn). * destination_retry_multiplier is now 2 instead of 5, the maximum value will be reached slower. * destination_max_retry_interval is one day instead of (essentially) infinity. Capping this will cause destinations to continue to be retried sometimes instead of being lost forever. The previous value was 2 ^ 62 milliseconds.
* Do not expose Admin API in caddy reverse proxy example (#16027)Nils2023-07-311-1/+1
| | | Signed-off-by: Nils ANDRÉ-CHANG <nils@nilsand.re>
* Fix broken Arch Linux package link (#15981)SnipeX_2023-07-241-2/+2
|
* Re-introduce the outbound federation proxy (#15913)Eric Eastwood2023-07-182-7/+50
| | | | | Allow configuring the set of workers to proxy outbound federation traffic through (`outbound_federation_restricted_to`). This is useful when you have a worker setup with `federation_sender` instances responsible for sending outbound federation requests and want to make sure *all* outbound federation traffic goes through those instances. Before this change, the generic workers would still contact federation themselves for things like profile lookups, backfill, etc. This PR allows you to set more strict access controls/firewall for all workers and only allow the `federation_sender`'s to contact the outside world.
* Document that you cannot login as yourself on ↵Will Hunt2023-07-141-1/+2
| | | | /_synapse/admin/v1/users/<user_id>/login (#15938)
* Stop accepting 'user' parameter for application service registration. (#15928)Patrick Cloke2023-07-131-0/+10
| | | This is unspecced, but has existed for a very long time.
* Better clarify how to run a worker instance (pass both configs) (#15921)Eric Eastwood2023-07-111-2/+2
| | | | | | | | | Previously, if you just followed the instructions per the docs, you just ran into an error: ```sh $ poetry run synapse_worker --config-path homeserver_generic_worker1.yaml Missing mandatory `server_name` config option. ```
* Bump Unix sockets intro version (#15924)Eric Eastwood2023-07-111-1/+1
| | | https://github.com/matrix-org/synapse/pull/15708 didn't quite make the cut for `1.88.0` this morning.
* Unix Sockets for HTTP Replication (#15708)Jason Little2023-07-113-4/+58
| | | | | | | | | Unix socket support for `federation` and `client` Listeners has existed now for a little while(since [1.81.0](https://github.com/matrix-org/synapse/pull/15353)), but there was one last hold out before it could be complete: HTTP Replication communication. This should finish it up. The Listeners would have always worked, but would have had no way to be talked to/at. --------- Co-authored-by: Eric Eastwood <madlittlemods@gmail.com> Co-authored-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> Co-authored-by: Eric Eastwood <erice@element.io>
* Drop debian buster (#15893)Shay2023-07-102-2/+2
|
* Revert "Federation outbound proxy" (#15910)Eric Eastwood2023-07-102-44/+7
| | | | | | Revert "Federation outbound proxy (#15773)" This reverts commit b07b14b494ae1dd564b4c44f844c9a9545b3d08a.
* Remove `worker_replication_*` settings from worker doc (#15872)Dirk Klimpel2023-07-075-21/+1
| | | Co-authored-by: Mathieu Velten <mathieuv@matrix.org>
* Remove `worker_replication_*` deprecated settings, with helpful errors on ↵Jason Little2023-07-073-48/+15
| | | | | | startup (#15860) Co-authored-by: reivilibre <oliverw@matrix.org>
* Federation outbound proxy (#15773)Eric Eastwood2023-07-052-7/+44
| | | | | | | Allow configuring the set of workers to proxy outbound federation traffic through (`outbound_federation_restricted_to`). This is useful when you have a worker setup with `federation_sender` instances responsible for sending outbound federation requests and want to make sure *all* outbound federation traffic goes through those instances. Before this change, the generic workers would still contact federation themselves for things like profile lookups, backfill, etc. This PR allows you to set more strict access controls/firewall for all workers and only allow the `federation_sender`'s to contact the outside world. The original code is from @erikjohnston's branches which I've gotten in-shape to merge.
* Remove support for Python 3.7 (#15851)Eric Eastwood2023-07-052-1/+13
| | | Fix https://github.com/matrix-org/synapse/issues/15836
* docs/admin_api: fix header level on 'Users' page (#15852)Sumner Evans2023-07-051-3/+3
| | | Signed-off-by: Sumner Evans <sumner@beeper.com>
* Add not_user_type param to the list accounts admin API (#15844)Michael Weimann2023-07-041-0/+3
| | | Signed-off-by: Michael Weimann <michaelw@element.io>
* Split out 2022 changes from the changelog (#15846)Eric Eastwood2023-06-281-0/+2766
| | | Split out 2022 changes from the changelog so the rendered version in GitHub doesn't timeout as much.
* Add login spam checker API (#15838)Erik Johnston2023-06-261-0/+36
|
* Fix typo in faster join docs (#15812)Erik Johnston2023-06-211-1/+1
| | | Fixes #15756
* Allow for the configuration of max request retries and min/max retry delays ↵Mathieu Velten2023-06-211-0/+26
| | | | in the matrix federation client (#15783)
* Fix admin api documentation typo (#15805)ew-at-vier2023-06-201-1/+1
| | | | | * Fix admin api documentation typo Signed-off-by: Eric Wolf <eric.wolf@vier.ai>
* Remove experimental MSC2716 implementation to incrementally import history ↵Eric Eastwood2023-06-161-1/+0
| | | | | | | | | | | | into existing rooms (#15748) Context for why we're removing the implementation: - https://github.com/matrix-org/matrix-spec-proposals/pull/2716#issuecomment-1487441010 - https://github.com/matrix-org/matrix-spec-proposals/pull/2716#issuecomment-1504262734 Anyone wanting to continue MSC2716, should also address these leftover tasks: https://github.com/matrix-org/synapse/issues/10737 Closes https://github.com/matrix-org/synapse/issues/10737 in the fact that it is not longer necessary to track those things.
* Revert "Allow for the configuration of max request retries and min/max retry ↵Mathieu Velten2023-06-141-26/+0
| | | | | | delays in the matrix federation client (#12504)" This reverts commit d84e66144dc12dacf71c987a2ba802dd59c0b68e.
* Bump minimum supported Rust version (#15768)Erik Johnston2023-06-121-0/+8
| | | | Important crates such as `log` and `regex` have bumped theirs to 1.60.0 as well.
* Allow for the configuration of max request retries and min/max retry delays ↵Shay2023-06-091-0/+26
| | | | | | | in the matrix federation client (#12504) Co-authored-by: Mathieu Velten <mathieuv@matrix.org> Co-authored-by: Erik Johnston <erik@matrix.org>
* Remove redundant `room_memberships` join to find participating servers in a ↵Eric Eastwood2023-06-071-3/+2
| | | | | room (#15732) Spawning from https://github.com/matrix-org/synapse/pull/15731
* Merge branch 'release-v1.85' into developH. Shay2023-06-011-0/+11
|\
| * Add a note about deprecating /register with a user property. (#15703)Patrick Cloke2023-06-011-0/+11
| | | | | | | | | | Application services providing a "user" property (instead of "username") for the /register endpoint was never specified. Deprecate this very old fallback.
* | Implement stable support for MSC3882 to allow an existing device/session to ↵Hugh Nimmo-Smith2023-06-011-22/+43
|/ | | | | | | | generate a login token for use on a new device/session (#15388) Implements stable support for MSC3882; this involves updating Synapse's support to match the MSC / the spec says. Continue to support the unstable version to allow clients to transition.
* Create dependabot changelogs at release time (#15481)David Robertson2023-05-301-5/+7
| | | | | | | | | * Ditch dependabot changelog workflow * Summarise dependabot commits in release script * Changelog * Update scripts-dev/release.py
* Add Unix socket support for Redis connections (#15644)Jason Little2023-05-261-0/+4
| | | | Adds a new configuration setting to connect to Redis via a Unix socket instead of over TCP. Disabled by default.
* Documentation improvements to contributing guide (#15667) (#15668)Grant McLean2023-05-261-5/+28
| | | | | | | | | Fix #15667 - Reiterate the importance of getting Rust installed and set up before attempting to install the Python dependencies. - Mention the importance of confirming that `poetry install` completed successfully and include a typical error that the user might see if it did not. - Expand on "Now edit homeserver.yaml" to give examples of things likely to need changing and to link to the relevant sections of the Synapse server documentation.
* Consolidate logic to check for deactivated users. (#15634)Patrick Cloke2023-05-231-0/+3
| | | | | | | This moves the deactivated user check to the method which all login types call. Additionally updates the application service tests to be more realistic by removing invalid tests and fixing server names.
* Merge branch 'master' into developOlivier Wilkinson (reivilibre)2023-05-231-6/+17
|\
| * Tweak changelog and upgrade notes v1.84.0Olivier Wilkinson (reivilibre)2023-05-231-6/+17
| |
* | Remove outdated comment in log config (#15648)Andrew Morgan2023-05-221-3/+1
| |
* | Remove old R30 because R30v2 supercedes it (#10428)reivilibre2023-05-191-5/+0
| | | | | | | | | | R30v2 has been out since 2021-07-19 (https://github.com/matrix-org/synapse/pull/10332) and we started collecting stats on 2021-08-16. Since it's been over a year now (almost 2 years), this is enough grace period for us to now rip it out.
* | Add a new admin API to create a new device for a user. (#15611)Quentin Gliech2023-05-171-0/+27
| | | | | | | | This allows an external service (e.g. the matrix-authentication-service) to create devices for users.
* | Update code to refer to "workers". (#15606)Patrick Cloke2023-05-161-6/+0
|/ | | | A bunch of comments and variables are out of date and use obsolete terms.
* Update Mastodon SSO instructions (#15587)villepeh2023-05-151-2/+4
|
* Add redis SSL configuration options (#15312)Roel ter Maat2023-05-111-0/+11
| | | | | | | | | | | | | | | | | * Add SSL options to redis config * fix lint issues * Add documentation and changelog file * add missing . at the end of the changelog * Move client context factory to new file * Rename ssl to tls and fix typo * fix lint issues * Added when redis attributes were added
* Remove `worker_replication_*` settings (#15491)Jason Little2023-05-114-22/+121
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add master to the instance_map as part of Complement, have ReplicationEndpoint look at instance_map for master. * Fix typo in drive by. * Remove unnecessary worker_replication_* bits from unit tests and add master to instance_map(hopefully in the right place) * Several updates: 1. Switch from master to main for naming the main process in the instance_map. Add useful constants for easier adjustment of names in the future. 2. Add backwards compatibility for worker_replication_* to allow time to transition to new style. Make sure to prioritize declaring main directly on the instance_map. 3. Clean up old comments/commented out code. 4. Adjust unit tests to match with new code. 5. Adjust Complement setup infrastructure to only add main to the instance_map if workers are used and remove now unused options from the worker.yaml template. * Initial Docs upload * Changelog * Missed some commented out code that can go now * Remove TODO comment that no longer holds true. * Fix links in docs * More docs * Remove debug logging * Apply suggestions from code review Co-authored-by: reivilibre <olivier@librepush.net> * Apply suggestions from code review Co-authored-by: reivilibre <olivier@librepush.net> * Update version to latest, include completeish before/after examples in upgrade notes. * Fix up and docs too --------- Co-authored-by: reivilibre <olivier@librepush.net>
* Fix documented path to largest rooms statistics endpoint. (#15560)Reto Schneider2023-05-101-1/+1
|
* Add config option to prevent media downloads from listed domains. (#15197)Travis Ralston2023-05-091-0/+24
| | | | | | | This stops media (and thumbnails) from being accessed from the listed domains. It does not delete any already locally cached media, but will prevent accessing it. Note that admin APIs are unaffected by this change.
* Clean up and clarify "Create or modify Account" Admin API documentation (#15544)Andrew Morgan2023-05-051-38/+49
|
* Allow running Complement integration tests via podman (#15543)Andrew Morgan2023-05-051-0/+1
|
* Merge branch 'release-v1.83' into developSean Quah2023-05-031-0/+1
|\
| * Fix up docs summary to include new experimental features admin API docsSean Quah2023-05-021-0/+1
| |
* | Add config option to forget rooms automatically when users leave them (#15224)Sean Quah2023-05-031-0/+10
| | | | | | | | | | This is largely based off the stats and user directory updater code. Signed-off-by: Sean Quah <seanq@matrix.org>
* | Remove references to supporting per-user flag for msc2654 (#15522)Shay2023-05-021-6/+7
| |
* | Allow adding random delay to push (#15516)Erik Johnston2023-05-021-0/+4
|/ | | This is to discourage timing based profiling on the push gateways.
* Add an admin API endpoint to support per-user feature flags (#15344)Shay2023-04-281-0/+54
|
* Update development docs referencing outdated versions of sqlite we no longer ↵Shay2023-04-281-33/+1
| | | | support (#15498)
* Docs: Add Nginx loadbalancing example with sticky mxid for workers (#15411)Tatu Wikman2023-04-271-2/+64
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Docs: Add Nginx loadbalancing example with sticky mxid for workers Add example nginx configuration snippet that * does load balancing for workers * respects mxid part of the token * from both url parameter and auth header * and handles since parameter Thanks to @olmari for pushing me to write this and testing the configs Signed-off-by: Tatu Wikman <tatu.wikman@gmail.com> * Add changelog entry Signed-off-by: Tatu Wikman <tatu.wikman@gmail.com> * Update codeblock formatter Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Remove indirectly related nginx-config Signed-off-by: Sami Olmari <sami@olmari.fi> * Proper definition of action how to target username for worker Signed-off-by: Sami Olmari <sami@olmari.fi> * Change "nginx" to general "reverse proxy" as it's concept now. Signed-off-by: Sami Olmari <sami@olmari.fi> * Wording in better English Co-authored-by: Tatu Wikman <tatu.wikman@gmail.com> * rename changelog entry to have correct extension --------- Signed-off-by: Tatu Wikman <tatu.wikman@gmail.com> Signed-off-by: Sami Olmari <sami@olmari.fi> Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Co-authored-by: Sami Olmari <sami@olmari.fi> Co-authored-by: Sami Olmari <sami+github@olmari.fi>
* Add admin endpoint to query room sizes (#15482)Erik Johnston2023-04-261-0/+49
|
* Add a note to the config documentation that the 'delete_stale_devices_after' ↵Andrew Morgan2023-04-171-0/+4
| | | | job always runs on the main process (#15452)
* Load `/capabilities` endpoint on workers (#15436)Dirk Klimpel2023-04-141-0/+1
|
* Delete pushers after calling on_logged_out module hook on device delete (#15410)Mathieu Velten2023-04-141-0/+3
|
* Load `/directory/room/{roomAlias}` endpoint on workers (#15333)Dirk Klimpel2023-04-141-0/+1
| | | | | | | | | * Enable `directory` * move to worker store * newsfile * disable `ClientDirectoryListServer` and `ClientAppserviceDirectoryListServer` for workers
* Note that Synapse 1.74 queued a user dir rebuild (#15386)David Robertson2023-04-041-0/+11
| | | | | * Note that Synapse 1.74 queued a user dir rebuild * Changelog
* Call appservices on modern paths, falling back to legacy paths. (#15317)Patrick Cloke2023-04-031-0/+16
| | | | | This uses the specced /_matrix/app/v1/... paths instead of the "legacy" paths. If the homeserver receives an error it will retry using the legacy path.
* Add the ability to enable/disable registrations when in the OIDC flow (#14978)Warren Bailey2023-03-301-0/+6
| | | Signed-off-by: Warren Bailey <warren@warrenbailey.net>
* Add some clarification to the doc/comments regarding TCP replication (#15354)Mathieu Velten2023-03-301-4/+5
|
* doc: fix account login requests ratelimit defaults typo (#15341)Jayesh Nirve2023-03-291-1/+1
| | | | | | | | | | | * doc: fix account login requests ratelimit defaults typo Signed-off-by: td <nirvejayesh@gmail.com> * chore: changelog.d file --------- Signed-off-by: td <nirvejayesh@gmail.com>
* Load `/password_policy` endpoint on workers. (#15331)Dirk Klimpel2023-03-271-0/+1
|
* Make `POST /_matrix/client/v3/rooms/{roomId}/report/{eventId}` endpoint ↵Andrew Morgan2023-03-211-0/+12
| | | | return 404 if event exists, but the user lacks access (#15300)
* Document that our Docker images are mirrored to GHCR. (#15282)reivilibre2023-03-211-2/+2
| | | Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
* Load `/register/available` endpoint on workers (#15268)Jason Little2023-03-171-0/+1
|
* Add a missing endpoint to the workers documentation. (#15223)Patrick Cloke2023-03-081-0/+1
|
* Add support for knocking to workers. (#15133)Dirk Klimpel2023-03-021-0/+1
|
* Update spam checker documentation for moved media modules. (#15175)Patrick Cloke2023-02-281-2/+2
|
* Allow use of the `/filter` Client-Server APIs on workers. (#15134)reivilibre2023-02-281-0/+1
|
* Add documentation for caching in a module (#14026)Brendan Abolivier2023-02-281-0/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add documentation for caching in a module * Changelog * Formatting * Wrap lines at a length that mdbook is happier with * Typo fix Co-authored-by: Erik Johnston <erik@matrix.org> * Link to recent version of the API In the longer term I'd like to see us generate markdown with Sphinx. * Refer to public `cached` decorator * Mark caching as being added in 1.74 Some of the underlying infrastructure was added in 1.69, but the public-facing `cached` decorator was only added in 1.74. It is the latter that I think we should be advertising. * Update docs/modules/writing_a_module.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> --------- Co-authored-by: David Robertson <davidr@element.io> Co-authored-by: Erik Johnston <erik@matrix.org> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Admin API endpoint to delete a reported event (#15116)Dirk Klimpel2023-02-281-0/+14
| | | | | | | | | | | | | | | | | | | | | * Admin api to delete event report * lint + tests * newsfile * Apply suggestions from code review Co-authored-by: David Robertson <david.m.robertson1@gmail.com> * revert changes - move to WorkerStore * update unit test * Note that timestamp is in millseconds --------- Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
* Correct documentation about registration_shared_secret_path (#15168)Evan Krall2023-02-281-2/+2
| | | | | | | | | | | * Correct documentation about registration_shared_secret_path * Create 15168.doc * Update changelog.d/15168.doc --------- Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
* Add module API callbacks for adding and deleting local 3PID associations (#15044Andrew Morgan2023-02-272-1/+68
|
* Fix typo in federation_verify_certificates in config documentation. (#15139)Centzilius2023-02-231-1/+1
|
* Add information on uploaded media to user export command. (#15107)Dirk Klimpel2023-02-231-16/+58
|
* Documentation using Shibboleth with OIDC Plugin for SSO. (#15112)Fly2023-02-231-0/+41
|
* Tighten the default rate limit of creating new devices. (#15135)Patrick Cloke2023-02-221-3/+3
|
* Clarify the workers that the ThirdPartyRules' `on_new_event` callback will ↵Andrew Morgan2023-02-221-0/+3
| | | | run on (#15071)
* Update database_maintenance_tools.md (#15083)jahway6032023-02-201-2/+2
| | | | | | | | | | * Update database_maintenance_tools.md Included a blog post by Jackson Chen, which DID work when I followed it to perform Matrix Synapse Maintenance, versus the 2020 blog post by Victor Berger, which DID NOT work when performining maintenance. * Update database_maintenance_tools.md * Rephrasing
* Add account data to export command (#14969)Dirk Klimpel2023-02-171-0/+3
| | | | | | | | | | | * Add account data to to export command * newsfile * remove not needed function * update newsfile * adopt #14973
* Document how to start Synapse with Poetry (#14892)ZAID BIN TARIQ2023-02-161-0/+11
| | | | | | | | | | | | | | | | * Add Start Synapse with Poetry * Create 14892.doc * Apply suggestions from code review Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com> * Update docs/workers.md --------- Co-authored-by: David Robertson <david.m.robertson1@gmail.com> Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Fix a mistake in registration_shared_secret_path docs (#15078)saddfox2023-02-151-1/+1
| | | | | | * fix a typo in registration_shared_secret_path docs Signed-off-by: Filip Rutar <filip.rutar@gmail.com> * changelog
* Support for selecting the Redis logical database. (#15034)999lakhisidhu2023-02-151-0/+4
| | | | Note that this is only used for key-value store (cached values) and not for the pub/sub replication used by Synapse.
* Respond correctly to unknown methods on known endpoints (#14605)Patrick Cloke2023-02-092-1/+19
| | | | Respond with a 405 error if a request is received on a known endpoint, but to an unknown method, per MSC3743.
* Document how to run Synapse (#15022)Andy Balaam2023-02-081-0/+13
| | | | | | | | * Document how to run Synapse * Changelog for 15022 * Update docs/development/contributing_guide.md
* Clarify limitations of SRV delegation in documentation (#14959)William Kray2023-02-081-0/+9
| | | | | | | | This PR just clarifies in the SRV DNS delegation document that there are still cases a user may have to serve files from `.well-known` endpoints, and this may not be a valid case for using SRV delegation. This has caused some confusion in a few cases. Signed-off-by: William Kray <github@williamkray.com>
* Allow enabling the asyncio reactor in complement (#14858)realtyem2023-02-011-0/+1
| | | Signed-off-by: Jason Little realtyem@gmail.com
* Add more user information to export-data command. (#14894)Dirk Klimpel2023-02-011-15/+65
| | | | | | * The user's profile information. * The user's devices. * The user's connections / IP address information.
* Merge branch 'master' into developH. Shay2023-01-313-1/+377
|\
| * update changelog and upgrade notes v1.76.0H. Shay2023-01-311-1/+1
| |
| * Initial batch of notes on faster joins (#14677)David Robertson2023-01-302-0/+376
| | | | | | | | Co-authored-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> Co-authored-by: Shay <hillerys@element.io>
* | Document how to handle Dependabot pull requests. (#14916)Patrick Cloke2023-01-251-0/+14
|/
* Document the export user data command. (#14883)ZAID BIN TARIQ2023-01-251-0/+8
|
* Request partial joins by default (#14905)David Robertson2023-01-241-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | * Request partial joins by default This is a little sloppy, but we are trying to gain confidence in faster joins in the upcoming RC. Admins can still opt out by adding the following to their Synapse config: ```yaml experimental: faster_joins: false ``` We may revert this change before the release proper, depending on how testing in the wild goes. * Changelog * Try to fix the backfill test failures * Upgrade notes * Postgres compat?
* Update logging_sample_config.md (#14868)Richard van der Hoff2023-01-191-3/+5
| | | | You do not have to restart synapse to reload the log config.
* Change default room version to 10. Implements MSC3904 (#14111)Catalan Lover2023-01-181-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Change Documentation to have v10 as default room version * Change Default Room version to 10 * Add changelog entry for default room version swap * Add changelog entry for v10 default room version in docs * Clarify doc changelog entry Co-authored-by: David Robertson <david.m.robertson1@gmail.com> * Improve Documentation changes. Co-authored-by: David Robertson <david.m.robertson1@gmail.com> * Update Changelog entry to have correct format Co-authored-by: David Robertson <david.m.robertson1@gmail.com> * Update Spec Version to 1.5 * Only need 1 changelog. * Fix test. * Update "Changed in" line Co-authored-by: David Robertson <david.m.robertson1@gmail.com> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> Co-authored-by: Patrick Cloke <patrickc@matrix.org>
* Require poetry>=1.3.2 (#14860)David Robertson2023-01-173-8/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Upgrade to new lockfile format Now requires poetry >= 1.2.2 to read and poetry >= 1.3.0 to write. Cheat sheet: ``` poetry --version poetry show > scratch/before pipx upgrade poetry poetry --version poetry show > scratch/after diff scratch{before,after} && echo "no change!" ``` * Use Poetry 1.3.2 when reading or writing lockfile * Remove unneeded(?) poetry dep for cibuildwheel * Update docs * Remove redundant call to setup-python * Remove outdated comments related to Poetry 1.x * Remove outdated docs line was fixed in #13082 * Minor improvements to poetry cheat sheet * Invoke setup-python-poetry with explicit version Not sure about this. It's hardcoding versions everywhere. * Changelog * Check the lockfile is version 2.0 Might one day incorporate other checks like #14742 * Typo fixes, thanks Sean Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com> Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Merge device list replication streams (#14833)Erik Johnston2023-01-171-4/+5
|
* Fix missing field in AS documentation (#14845)Rhea Danzey2023-01-161-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Fix missing field in AS documentation The [AS Configuration Snippet](https://matrix-org.github.io/synapse/latest/application_services.html) is missing `id` field, without it Synapse will fail to load: ``` synapse-synapse-main-0 synapse 2023-01-13 23:05:25,450 - synapse.storage.databases - 84 - INFO - main - [database config 'master']: Starting 'main' database synapse-synapse-main-0 synapse 2023-01-13 23:05:25,452 - synapse.config.appservice - 79 - ERROR - main - Failed to load appservice from '/as/synapse-hookshot-as/registration.yaml' synapse-synapse-main-0 synapse 2023-01-13 23:05:25,452 - synapse.config.appservice - 80 - ERROR - main - "Required string field: 'id' (/as/synapse-hookshot-as/registration.yaml)" synapse-synapse-main-0 synapse Traceback (most recent call last): synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/config/appservice.py", line 57, in load_appservices synapse-synapse-main-0 synapse appservice = _load_appservice(hostname, yaml.safe_load(f), config_file) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/config/appservice.py", line 91, in _load_appservice synapse-synapse-main-0 synapse raise KeyError( synapse-synapse-main-0 synapse KeyError: "Required string field: 'id' (/as/synapse-hookshot-as/registration.yaml)" synapse-synapse-main-0 synapse 2023-01-13 23:05:25,452 - synapse.app._base - 207 - ERROR - main - Exception during startup synapse-synapse-main-0 synapse Traceback (most recent call last): synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/app/homeserver.py", line 340, in setup synapse-synapse-main-0 synapse hs.setup() synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/server.py", line 310, in setup synapse-synapse-main-0 synapse self.datastores = Databases(self.DATASTORE_CLASS, self) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/__init__.py", line 93, in __init__ synapse-synapse-main-0 synapse main = main_store_class(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/__init__.py", line 139, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/events_bg_updates.py", line 98, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/devices.py", line 1584, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/devices.py", line 89, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/roommember.py", line 1494, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/room.py", line 1827, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/room.py", line 1365, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/room.py", line 119, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/registration.py", line 2158, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/presence.py", line 67, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/presence.py", line 48, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/transactions.py", line 73, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/state.py", line 666, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/state.py", line 82, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/state.py", line 470, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/event_federation.py", line 2007, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/media_repository.py", line 148, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/media_repository.py", line 68, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/push_rule.py", line 330, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/event_push_actions.py", line 1938, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/metrics.py", line 68, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/event_push_actions.py", line 249, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/end_to_end_keys.py", line 1181, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/search.py", line 426, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/search.py", line 137, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/account_data.py", line 64, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/push_rule.py", line 114, in __init__ synapse-synapse-main-0 synapse super().__init__(database, db_conn, hs) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/storage/databases/main/appservice.py", line 76, in __init__ synapse-synapse-main-0 synapse self.services_cache = load_appservices( synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/config/appservice.py", line 57, in load_appservices synapse-synapse-main-0 synapse appservice = _load_appservice(hostname, yaml.safe_load(f), config_file) synapse-synapse-main-0 synapse File "/usr/local/lib/python3.9/site-packages/synapse/config/appservice.py", line 91, in _load_appservice synapse-synapse-main-0 synapse raise KeyError( synapse-synapse-main-0 synapse KeyError: "Required string field: 'id' (/as/synapse-hookshot-as/registration.yaml)" synapse-synapse-main-0 synapse ****************************************************************************** synapse-synapse-main-0 synapse Error during initialisation: synapse-synapse-main-0 synapse "Required string field: 'id' (/as/synapse-hookshot-as/registration.yaml)" synapse-synapse-main-0 synapse There may be more information in the logs. synapse-synapse-main-0 synapse ****************************************************************************** ``` * Changelog
* Merge account data streams (#14826)Erik Johnston2023-01-131-0/+12
|
* Update misleading documentation ` user_directory.search_all_users ` (#14818)Tejaswini Gurram2023-01-131-2/+2
| | | Fixes #13852
* Add `worker_manhole` to configuration manual (#14824)Dirk Klimpel2023-01-131-0/+21
| | | Closes: #13643
* Include `x_forwarded` in workers example configs (#14667)villepeh2023-01-133-2/+3
|
* Remove outdated commands from the code style doc & point to the contributing ↵Andrew Morgan2023-01-111-12/+3
| | | | guide. (#14773)
* Add listener `health` (#14747)Dirk Klimpel2023-01-111-0/+6
| | | Fixes: #8780
* Add `tag` to `listeners` documentation (#14803)Dirk Klimpel2023-01-112-2/+6
| | | | | * Add `tag` to `listeners` documentation * newsfile
* Add missing worker settings to shared configuration (#14748)Dirk Klimpel2023-01-092-11/+84
| | | | | | | | | | | | | * Add missing worker settings to shared configuration * newsfile * update docs after review * more update for doc * This -> These Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
* Update link to towncrier in contribution guide (#14801)Dirk Klimpel2023-01-091-1/+1
| | | | | * Update link to towncrier in contribution guide * newsfile
* Fix upgrade notes for installing ICU (#14797)David Robertson2023-01-091-1/+1
| | | | | | | * Fix upgrade notes for installing ICU As noticed in https://github.com/matrix-org/synapse/pull/14712/files#r1058433297 * Changelog
* Fix broken links in the Synapse documentation. (#14744)reivilibre2023-01-0523-38/+37
| | | | | | | | | | | | | | | | | * Fix stale external links * Fix some internal links * Fix URLs without trailing / where needed * Fix more links * Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> * Reapply docs/openid.md fix after conflict Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
* Document how to use Twitter as an OAuth 2.0 provider. (#14778)Patrick Cloke2023-01-041-283/+319
| | | This also alphabetizes the documentation for the various OpenID providers.
* Support RFC7636 PKCE in the OAuth 2.0 flow. (#14750)Patrick Cloke2023-01-041-1/+6
| | | | | | | PKCE can protect against certain attacks and is enabled by default. Support can be controlled manually by setting the pkce_method of each oidc_providers entry to 'auto' (default), 'always', or 'never'. This is required by Twitter OAuth 2.0 support.
* Support non-OpenID compliant user info endpoints (#14753)Patrick Cloke2023-01-041-0/+18
| | | | | | | | OpenID specifies the format of the user info endpoint and some OAuth 2.0 IdPs do not follow it, e.g. NextCloud and Twitter. This adds subject_template and picture_template options to the default mapping provider for more flexibility in matching those user info responses.
* Broken link "request_id_header" (#14740)Vertux2022-12-281-1/+1
| | | | | | | | | * Broken link "request_id_header" The link above leads to an ERROR 404 * Update docs/reverse_proxy.md Co-authored-by: reivilibre <olivier@librepush.net>
* Move `email` to Server section in config file documentation (#14730)Dirk Klimpel2022-12-281-108/+109
| | | | | * Move `email` to server in config file documentation * changelog
* Update docs about ruff vs. flake8.Patrick Cloke2022-12-211-2/+2
|
* Merge branch 'master' into developSean Quah2022-12-203-6/+30
|\
| * Add release note and update doc regarding ICU (#14712)Mathieu Velten2022-12-203-6/+30
| | | | | | | | | | Fixes #14704. Signed-off-by: Mathieu Velten <mathieuv@matrix.org>
* | Fix missing word in autotune sub-option description (#14674)Jeremy Kescher2022-12-141-1/+1
| | | | | | | | | | | | | | Fix `target_memory_usage` being used in the description for the actual `cache_autotune` sub-option `target_cache_memory_usage`. Signed-off-by: Jeremy Kescher <jeremy@kescher.at> Signed-off-by: Jeremy Kescher <jeremy@kescher.at>
* | Declare support for Python 3.11 (#14673)David Robertson2022-12-131-1/+1
|/ | | | | * Declare support for Python 3.11 * Changelog
* Allow selecting "prejoin" events by state keys (#14642)David Robertson2022-12-131-18/+39
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Declare new config * Parse new config * Read new config * Don't use trial/our TestCase where it's not needed Before: ``` $ time trial tests/events/test_utils.py > /dev/null real 0m2.277s user 0m2.186s sys 0m0.083s ``` After: ``` $ time trial tests/events/test_utils.py > /dev/null real 0m0.566s user 0m0.508s sys 0m0.056s ``` * Helper to upsert to event fields without exceeding size limits. * Use helper when adding invite/knock state Now that we allow admins to include events in prejoin room state with arbitrary state keys, be a good Matrix citizen and ensure they don't accidentally create an oversized event. * Changelog * Move StateFilter tests should have done this in #14668 * Add extra methods to StateFilter * Use StateFilter * Ensure test file enforces typed defs; alphabetise * Workaround surprising get_current_state_ids * Whoops, fix mypy
* Update admin_faq.mdRichard van der Hoff2022-12-071-1/+1
|
* Add Mastodon SSO setup instructions to docs (#14594)villepeh2022-12-071-0/+41
| | | Fixes https://github.com/matrix-org/synapse/issues/14147
* Change `turn_allow_guests` example value to lowercase `true` (#14634)villepeh2022-12-071-1/+1
| | | | | * Set `turn_allow_guests` example value to lowercase * Create 14634.doc
* docs: Replace old note about Postgres 10+ being required with link to our ↵Andrew Morgan2022-12-061-1/+2
| | | | deprecation policy (#14590)
* Fix push.enabled config documentation (#14619)Will Hunt2022-12-051-2/+2
| | | | | | | * Fix push.enabled config documentation * Create 14619.doc * Update 14619.doc
* Update worker docs to update preferred settings for pusher and ↵realtyem2022-12-022-31/+52
| | | | | | | | | | | | | | | | | | | | | federation_sender (#14493) * Fix one typo on line 3700(and apparently do something to other lines, no idea) * Update config_documentation.md with more information about how federation_senders and pushers settings can be handled. Specifically, that the instance map style of config does not require the special other variables that enable and disable functionality and that a single worker CAN be added to the map not only just two or more. * Extra line here for consistency and appearance. * Add link to sygnal repo. * Add deprecation notice to workers.md and point to the newer alternative method of defining this functionality. * Changelog * Correct version number of Synapse the deprecation is happening in. * Update quiet deprecation with simple notice and suggestion.
* Add `push.enabled` option to disable push notification calculation (#14551)Will Hunt2022-12-011-0/+5
| | | | | | | * Add initial option * changelog * Some more linting
* Cite launchpad bug that says ubuntu's pkgs are old (#14517)David Robertson2022-11-301-6/+13
| | | | | | | * Cite launchpad bug that says ubuntu's pkgs are old * Add some cross-references while I'm here * Changelog
* Move MSC3030 `/timestamp_to_event` endpoint to stable v1 location (#14471)Eric Eastwood2022-11-281-0/+2
| | | | | | | | Fix https://github.com/matrix-org/synapse/issues/14390 - Client API: `/_matrix/client/unstable/org.matrix.msc3030/rooms/<roomID>/timestamp_to_event?ts=<timestamp>&dir=<direction>` -> `/_matrix/client/v1/rooms/<roomID>/timestamp_to_event?ts=<timestamp>&dir=<direction>` - Federation API: `/_matrix/federation/unstable/org.matrix.msc3030/timestamp_to_event/<roomID>?ts=<timestamp>&dir=<direction>` -> `/_matrix/federation/v1/timestamp_to_event/<roomID>?ts=<timestamp>&dir=<direction>` Complement test changes: https://github.com/matrix-org/complement/pull/559
* Add support for handling avatar with SSO login (#13917)Ashish Kumar2022-11-251-1/+8
| | | | | | | | This commit adds support for handling a provided avatar picture URL when logging in via SSO. Signed-off-by: Ashish Kumar <ashfame@users.noreply.github.com> Fixes #9357.
* Remove legacy Prometheus metrics names. They were deprecated in Synapse ↵reivilibre2022-11-242-25/+22
| | | | v1.69.0 and disabled by default in Synapse v1.71.0. (#14538)
* Fix broken admin API request recommendation link (#14499)Brennan Chapman2022-11-211-1/+1
| | | Signed-off-by: Brennan Chapman <brennan@chapmanb.com>
* Fix version that `worker_main_http_uri` is redundant from (#14476)David Robertson2022-11-171-2/+2
| | | | | * Fix version that `worker_main_http_uri` is redundant from * Changelog
* Remove need for `worker_main_http_uri` setting to use /keys/upload. (#14400)realtyem2022-11-161-4/+3
|
* Support using SSL on worker endpoints. (#14128)Tuomas Ojamies2022-11-151-0/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Fix missing SSL support in worker endpoints. * Add changelog * SSL for Replication endpoint * Remove unit test change * Refactor listener creation to reduce duplicated code * Fix the logger message * Update synapse/app/_base.py Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * Update synapse/app/_base.py Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * Update synapse/app/_base.py Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * Add config documentation for new TLS option Co-authored-by: Tuomas Ojamies <tojamies@palantir.com> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> Co-authored-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
* Include additional TURN server example into documentation (#14293)sando382022-11-144-211/+389
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Include eturnal TURN server configuration example and moving specific configuration examples into sub folders. * Update docs/turn-howto.md Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Update docs/setup/turn/coturn.md Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Update docs/setup/turn/eturnal.md Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Fix TURN relaying public IP address hint * lint eturnal installation commands * Adjust synapse setup to link to existing documentation ..avoid redundant information. * remove redundant text * include alpine linux package link * Create 14293.doc * Update 14293.doc add missing dot * Update docs/setup/turn/eturnal.md Co-authored-by: reivilibre <olivier@librepush.net> * Update docs/setup/turn/eturnal.md Co-authored-by: reivilibre <olivier@librepush.net> * Update docs/setup/turn/coturn.md Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com> * Update docs/setup/turn/coturn.md Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com> * Update docs/setup/turn/coturn.md Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com> * Update docs/setup/turn/eturnal.md Co-authored-by: reivilibre <olivier@librepush.net> * Update docs/setup/turn/coturn.md Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com> * Update docs/setup/turn/coturn.md Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com> * Update eturnal.md to link to official documentation ... and to simplify some aspects * Adjust coturn to link to default prefix * Mention eturnalctl location * Update docs/turn-howto.md Co-authored-by: Saarko <sandomir@tutanotal.com> Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Co-authored-by: reivilibre <olivier@librepush.net> Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>
* Update sample Nginx configuration to HTTP 1.1 (#14414)Brad Jones2022-11-111-0/+3
| | | | Signed-off-by: Brad Jones <brad@kinksters.dating>
* Add an Admin API endpoint for looking up users based on 3PID (#14405)Ashish Kumar2022-11-111-0/+39
|
* Remove support for PostgreSQL 10 (#14392)Sean Quah2022-11-081-0/+10
| | | Signed-off-by: Sean Quah <seanq@matrix.org>
* Allow override for requesting specific worker types for Complement on ↵realtyem2022-11-081-0/+6
| | | | | | | | | | | | | | | | | | | | | | | command line. (#14324) * Expose getting SYNAPSE_WORKER_TYPES from external, allowing override of workers requested. * Add WORKER_TYPES variable option to complement.sh script that passes requested workers into start_for_complement.sh entrypoint. * Update docs to reflect this new ability. * Changelog * Don't rely on soft wrapping to format long strings Good idea dklimpel. Thanks for catching that. Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Small nits just noticed in docs. * Fixup new line in docs. Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>
* Add example on how to load balance /sync requests (#14297)aceArt-GmbH2022-11-071-3/+5
| | | | | Signed-off-by: lukas <lukas.walter@aceart.de> Signed-off-by: lukas <lukas.walter@aceart.de>
* Include monthly active user metrics in the list of legacy metrics names ↵David Robertson2022-11-041-0/+3
| | | | (#14360)
* Update legacy `synapse_admin_mau:` metric names in docs (#14358)Will Hunt2022-11-031-3/+3
| | | | | * Rename legacy metrics in MAU docs * changelog
* Disable legacy Prometheus metric names by default. They can still be ↵reivilibre2022-11-022-2/+18
| | | | re-enabled for now, but they will be removed altogether in Synapse 1.73.0. (#14353)
* Support OIDC backchannel logouts (#11414)Quentin Gliech2022-10-312-0/+23
| | | | | | | If configured an OIDC IdP can log a user's session out of Synapse when they log out of the identity provider. The IdP sends a request directly to Synapse (and must be configured with an endpoint) when a user logs out.
* Add docs for an empty `trusted_key_servers` config option (#13999)Dirk Klimpel2022-10-281-0/+6
| | | | | | | * Add docs for an empty `trusted_key_servers` config option * small rewording * Tweak changelog
* Check appservice user interest against the local users instead of all users ↵Eric Eastwood2022-10-271-0/+19
| | | | (`get_users_in_room` mis-use) (#13958)
* Add workers settings to configuration manual (#14086)Dirk Klimpel2022-10-273-81/+289
| | | | | | | | | | | | | | | | | | | | * Add workers settings to configuration manual * Update `pusher_instances` * update url to python logger * update headlines * update links after headline change * remove link from `daemon process` There is no docs in Synapse for this * extend example for `federation_sender_instances` and `pusher_instances` * more infos about stream writers * add link to DAG * update `pusher_instances` * update `worker_listeners` * update `stream_writers` * Update `worker_name` Co-authored-by: David Robertson <davidr@element.io>
* Save login tokens in database (#13844)Quentin Gliech2022-10-261-0/+9
| | | | | | | | | | | * Save login tokens in database Signed-off-by: Quentin Gliech <quenting@element.io> * Add upgrade notes * Track login token reuse in a Prometheus metric Signed-off-by: Quentin Gliech <quenting@element.io>
* Show erasure status when listing users in the Admin API (#14205)Tadeusz Sośnierz2022-10-211-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Show erasure status when listing users in the Admin API * Use USING when joining erased_users * Add changelog entry * Revert "Use USING when joining erased_users" This reverts commit 30bd2bf106415caadcfdbdd1b234ef2b106cc394. * Make the erased check work on postgres * Add a testcase for showing erased user status * Appease the style linter * Explicitly convert `erased` to bool to make SQLite consistent with Postgres This also adds us an easy way in to fix the other accidentally integered columns. * Move erasure status test to UsersListTestCase * Include user erased status when fetching user info via the admin API * Document the erase status in user_admin_api * Appease the linter and mypy * Signpost comments in tests Co-authored-by: Tadeusz Sośnierz <tadeusz@sosnierz.com> Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
* Document encryption_enabled_by_default_for_room_type under the right name ↵Matthew Hodgson2022-10-191-1/+1
| | | | | | | | | (#14110) * document encryption_enabled_by_default_for_room_type under the right name * add changelog * Update changelog.d/14110.doc
* Fix dead link to admin registration API (#14189)David Robertson2022-10-171-1/+1
| | | | | * Fix dead link to admin registration API * Changelog
* Stabilize the threads API. (#14175)Patrick Cloke2022-10-141-0/+1
| | | | | | | Stabilize the threads API (MSC3856) by supporting (only) the v1 path for the endpoint. This also marks the API as safe for workers since it is a read-only API.
* Mark /relations endpoint as usable on workers. (#14028)Patrick Cloke2022-10-121-0/+1
| | | Co-authored-by: Eric Eastwood <erice@element.io>
* Handle `gottestfmt` repository move (#14144)David Robertson2022-10-111-1/+1
|
* Fix name of "alias_creation_rules" option in config manual (#14124)Andrew Morgan2022-10-101-2/+2
|
* Document Google OpenID Connect email attribute (#14081)Paul Tötterman2022-10-071-1/+2
|
* Improve the listener example on the metrics documentation (#14078)Dirk Klimpel2022-10-071-12/+29
| | | Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
* Add sample worker files for `pusher` and `federation_sender` (#14077)Dirk Klimpel2022-10-073-0/+28
| | | Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
* Fix broken links to README (#14093)David Robertson2022-10-061-1/+1
|
* Merge tag 'v1.69.0rc2' into developSean Quah2022-10-061-0/+33
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Synapse 1.69.0rc2 (2022-10-06) ============================== Please note that legacy Prometheus metric names are now deprecated and will be removed in Synapse 1.73.0. Server administrators should update their dashboards and alerting rules to avoid using the deprecated metric names. See the [upgrade notes](https://matrix-org.github.io/synapse/v1.69/upgrade.html#upgrading-to-v1690) for more details. Deprecations and Removals ------------------------- - Deprecate the `generate_short_term_login_token` method in favor of an async `create_login_token` method in the Module API. ([\#13842](https://github.com/matrix-org/synapse/issues/13842)) Internal Changes ---------------- - Ensure Synapse v1.69 works with upcoming database changes in v1.70. ([\#14045](https://github.com/matrix-org/synapse/issues/14045)) - Fix a bug introduced in Synapse v1.68.0 where messages could not be sent in rooms with non-integer `notifications` power level. ([\#14073](https://github.com/matrix-org/synapse/issues/14073)) - Temporarily pin build-system requirements to workaround an incompatibility with poetry-core 1.3.0. This will be reverted before the v1.69.0 release proper, see [\#14079](https://github.com/matrix-org/synapse/issues/14079). ([\#14080](https://github.com/matrix-org/synapse/issues/14080))
| * Deprecate the `generate_short_term_login_token` method in favor of an async ↵Quentin Gliech2022-10-061-0/+33
| | | | | | | | | | | | `create_login_token` method in the Module API. (#13842) Signed-off-by: Quentin Gliech <quenting@element.io> Co-authored-by: Brendan Abolivier <babolivier@matrix.org>
* | The changelog entry ending in a `.` or `!` is not optional (#14087)Andre Klärner2022-10-061-1/+1
| |
* | openid.md: fix a typo in the facebook exampleRichard van der Hoff2022-10-061-1/+1
|/
* Linkify config documentation. (#14003)Akshit Tyagi2022-10-041-5/+7
|
* Announce that legacy metric names are deprecated, will be turned off by ↵reivilibre2022-10-033-1/+63
| | | | default in Synapse v1.71.0 and removed altogether in Synapse v1.73.0. (#14024)
* Add some cross references to worker documentation (#13974)Dirk Klimpel2022-09-302-15/+27
| | | | Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
* Add upgrade notes for changes to receipts replication. (#13932)Patrick Cloke2022-09-281-0/+12
|
* Document that the 'auto_join_rooms' option works with Spaces (#13931)Andrew Morgan2022-09-281-2/+5
|
* Add instruction for running unit tests in parallel (#13928)Ashish Kumar2022-09-281-0/+6
|
* Emphasize the right reasons to use `(room_id, event_id)` in a schema (#13915)Eric Eastwood2022-09-271-15/+16
| | | | | | | * Emphasize the right reasons to use (room_id, event_id) Follow-up to: - https://github.com/matrix-org/synapse/pull/13701 - https://github.com/matrix-org/synapse/pull/13771
* Merge branch 'master' into developDavid Robertson2022-09-271-6/+23
|\
| * Update upgrade notes (#13923)David Robertson2022-09-271-6/+23
| | | | | | | | | | | | | | | | | | * Update upgrade notes * Synapse Synapse Synapse Synapse Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* | Merge branch 'master' into developDavid Robertson2022-09-271-3/+9
|\|
| * Clarify who isn't affected by rust v1.68.0David Robertson2022-09-271-2/+6
| |
| * tweak upgrade notesDavid Robertson2022-09-271-3/+5
| |
* | Update NixOS module URL (#13818)enterprisey2022-09-261-1/+1
| | | | | | | | | | * Update NixOS module URL * Create 13818.doc
* | Fix the cross-link from register admin API to config docs. (#13870)Patrick Cloke2022-09-221-1/+1
| |
* | Correct documentation for map_user_attributes of OpenID Mapping Providers ↵Peter Scheu2022-09-211-3/+9
|/ | | | | (#13836) Co-authored-by: David Robertson <davidr@element.io>
* Edit changelog in response to feedbackOlivier Wilkinson (reivilibre)2022-09-201-1/+9
|
* Add an admin API endpoint to find a user based on its external ID in an auth ↵Quentin Gliech2022-09-161-0/+38
| | | | provider. (#13810)
* Update request log format documentation to mention the format used when the ↵reivilibre2022-09-161-2/+2
| | | | authenticated user is controlling another user. (#13794)
* Document common fix of Poetry problems by removing egg-info (#13785)Eric Eastwood2022-09-151-0/+27
| | | | | `matrix_synapse.egg-info/` Mentioned at https://matrix.to/#/!vcyiEtMVHIhWXcJAfl:sw1v.org/$aKy_IjrKwb70aTVZWeW_6zt0k7OIZ1YkyZpkP9uiRaM?via=matrix.org&via=element.io&via=beeper.com and many other places.
* Be able to correlate timeouts in reverse-proxy layer in front of Synapse ↵Eric Eastwood2022-09-152-1/+14
| | | | | | | | | | | | | | | | | | (pull request ID from header) (#13801) Fix https://github.com/matrix-org/synapse/issues/13685 New config: ```diff listeners: - port: 8008 tls: false type: http x_forwarded: true + request_id_header: "cf-ray" bind_addresses: ['::1', '127.0.0.1', '0.0.0.0'] ```
* Merge branch 'master' into developErik Johnston2022-09-131-0/+24
|\
| * Add minimum version bump for sqlite to the release notes (#13742)David Robertson2022-09-081-0/+15
| | | | | | | | | | | | * Notify that SQLite min version will be bumped * Mention in upgrade notes Co-authored-by: reivilibre <oliverw@matrix.org>
| * Update changelogErik Johnston2022-09-061-0/+9
| |
* | installation.md: require libpq on M1 macs (#13480)Richard van der Hoff2022-09-131-2/+3
| |
* | Fix typo in ratelimiting documentation (#13727)Brendan Abolivier2022-09-121-1/+1
| |
* | Add timestamp to user's consent (#13741)Dirk Klimpel2022-09-081-0/+2
| | | | | | Co-authored-by: reivilibre <olivier@librepush.net>
* | Correct out-of-date doc for `event_cache_size` (#13726)David Robertson2022-09-071-2/+4
| |
* | Define SQLite compat policy (#13728)David Robertson2022-09-071-4/+11
| |
* | Add Admin API to Fetch Messages Within a Particular Window (#13672)Connor Davis2022-09-071-0/+145
| | | | | | This adds two new admin APIs that allow us to fetch messages from a room within a particular time.
* | Add a stub Rust crate (#12595)Erik Johnston2022-09-063-1/+26
|/
* Remove configuration options for direct TCP replication. (#13647)Patrick Cloke2022-09-063-19/+20
| | | Removes the ability to configure legacy direct TCP replication. Workers now require Redis to run.
* Clarify `(room_id, event_id)` global uniqueness (#13701)Eric Eastwood2022-09-021-0/+24
| | | Summarized from @richvdh's reply at https://github.com/matrix-org/synapse/pull/13589#discussion_r961116999
* Update docs to make enabling metrics more clear (#13678)Eric Eastwood2022-09-021-4/+7
| | | It was really easy to miss the `enable_metrics: True` step with the previous language.
* Update lock file for Poetry v1.2.0 (#13689)Erik Johnston2022-09-023-6/+12
|
* Fix two typos with colon in headlines (#13665)Dirk Klimpel2022-09-011-2/+2
|
* Add monthly active users documentation (#13617)Will Hunt2022-09-013-0/+87
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add monthly active users documentation * changelog * Tidy up notes * more tidyup * Rewrite #1 * link back to mau docs * fix links * s/appservice|AS/application service * further review * a newline * Remove bit about shadow banned users. I think talking about them is confusing, and the current text doesn't imply they get any special treatment. * Update docs/usage/administration/monthly_active_users.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * Update docs/usage/administration/monthly_active_users.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> Co-authored-by: Brendan Abolivier <babolivier@matrix.org> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>