summary refs log tree commit diff
path: root/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* Merge branch 'master' into developSean Quah2022-08-312-2/+2
|\
| * Improve clarity on deprecation of TCP replicationSean Quah2022-08-311-1/+1
| | | | | | | | | | Borrows some text from https://github.com/matrix-org/synapse/pull/13647 for the changelog.
| * Fix dead link in 1.18.0 upgrade notesSean Quah2022-08-311-1/+1
| |
* | 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
|