summary refs log tree commit diff
path: root/docs/usage (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Use dbname instead of database for Postgres config. (#16618)Patrick Cloke2023-11-091-3/+3
|
* 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).
* Rework alias and public room list rules docs (#16541)David Robertson2023-10-241-34/+132
|
* Fix typo in useful_sql_for_admins.md (#16477)Laurence Gill2023-10-121-1/+1
|
* Add note to 'federation_domain_whitelist' option (#16416)Erik Johnston2023-10-031-0/+5
|
* Remove warnings from the docs about using message retention. (#16382)Patrick Cloke2023-09-281-5/+2
| | | | | 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.
* Use string for federation_client_minimum_tls_version documentation examples ↵Jan Christian Grünhage2023-09-191-4/+4
| | | | (#16353)
* 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>
* Fix-up incorrect spellings in docs. (#16282)Patrick Cloke2023-09-082-3/+3
|
* 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>
* Add warnings about MSC3861 on certain APIs. (#16168)Will Hunt2023-08-251-0/+2
|
* 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
|
* Add `client_secret_path` as alternative for `client_secret` for OIDC config ↵Maximilian Bosch2023-08-211-0/+8
| | | | (#16030)
* 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-101-0/+2
|
* Move support for application service query parameter authorization behind a ↵Shay2023-08-031-0/+14
| | | | 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.
* Re-introduce the outbound federation proxy (#15913)Eric Eastwood2023-07-181-7/+26
| | | | | 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.
* 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-111-1/+51
| | | | | | | | | 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>
* Revert "Federation outbound proxy" (#15910)Eric Eastwood2023-07-101-24/+7
| | | | | | Revert "Federation outbound proxy (#15773)" This reverts commit b07b14b494ae1dd564b4c44f844c9a9545b3d08a.
* Remove `worker_replication_*` deprecated settings, with helpful errors on ↵Jason Little2023-07-071-45/+0
| | | | | | startup (#15860) Co-authored-by: reivilibre <oliverw@matrix.org>
* Federation outbound proxy (#15773)Eric Eastwood2023-07-051-7/+24
| | | | | | | 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.
* 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)
* 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.
* 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
* 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.
* 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.
* 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 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-111-6/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* 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.
* 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>
* 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 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)
* 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>
* 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>
* 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>
* 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
|
* Tighten the default rate limit of creating new devices. (#15135)Patrick Cloke2023-02-221-3/+3
|
* 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
* 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.
* 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.
* Document the export user data command. (#14883)ZAID BIN TARIQ2023-01-251-0/+8
|
* 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>
* 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
* 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-091-6/+48
| | | | | | | | | | | | | * 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>
* Fix broken links in the Synapse documentation. (#14744)reivilibre2023-01-057-12/+12
| | | | | | | | | | | | | | | | | * 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>
* 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.
* 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
* 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>
* 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
|
* 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-021-31/+44
| | | | | | | | | | | | | | | | | | | | | 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
* 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-241-25/+0
| | | | 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>
* 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>
* 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-021-2/+2
| | | | re-enabled for now, but they will be removed altogether in Synapse 1.73.0. (#14353)
* Support OIDC backchannel logouts (#11414)Quentin Gliech2022-10-311-0/+9
| | | | | | | 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
* Add workers settings to configuration manual (#14086)Dirk Klimpel2022-10-271-48/+220
| | | | | | | | | | | | | | | | | | | | * 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>
* 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
* Fix name of "alias_creation_rules" option in config manual (#14124)Andrew Morgan2022-10-101-2/+2
|
* Fix broken links to README (#14093)David Robertson2022-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-031-0/+25
| | | | default in Synapse v1.71.0 and removed altogether in Synapse v1.73.0. (#14024)
* Document that the 'auto_join_rooms' option works with Spaces (#13931)Andrew Morgan2022-09-281-2/+5
|
* Update request log format documentation to mention the format used when the ↵reivilibre2022-09-161-2/+2
| | | | authenticated user is controlling another user. (#13794)
* Be able to correlate timeouts in reverse-proxy layer in front of Synapse ↵Eric Eastwood2022-09-151-1/+10
| | | | | | | | | | | | | | | | | | (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'] ```
* Fix typo in ratelimiting documentation (#13727)Brendan Abolivier2022-09-121-1/+1
|
* Correct out-of-date doc for `event_cache_size` (#13726)David Robertson2022-09-071-2/+4
|
* Remove configuration options for direct TCP replication. (#13647)Patrick Cloke2022-09-061-2/+0
| | | Removes the ability to configure legacy direct TCP replication. Workers now require Redis to run.
* Fix two typos with colon in headlines (#13665)Dirk Klimpel2022-09-011-2/+2
|
* Add monthly active users documentation (#13617)Will Hunt2022-09-012-0/+86
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-311-1/+1
|\
| * 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.
* | Improve documentation around user registration (#13640)Richard van der Hoff2022-08-261-91/+116
| | | | | | | | | | 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.
* Drop support for delegating email validation, round 2 (#13596)David Robertson2022-08-231-1/+4
|
* 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
|
* 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-151-1/+5
| | | | database corruption (#13497)
* 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
|
* 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 tag 'v1.64.0rc2' into developRichard van der Hoff2022-07-291-181/+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-291-181/+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)
* 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
* 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-192-7/+12
|\|
| * Remove 'anonymised' from the phone home stats documentation (#13321)Andrew Morgan2022-07-192-7/+12
| |
* | 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-191-0/+19
| |
* | 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>
* | Drop support for delegating email validation (#13192)Richard van der Hoff2022-07-121-16/+12
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* Document the 'databases' homeserver config option (#13212)Andrew Morgan2022-07-111-0/+92
|
* Add missing links to config options (#13166)Dirk Klimpel2022-07-051-3/+3
|
* Add documentation for phone home stats (#13086)Andrew Morgan2022-06-301-0/+81
|
* Cleanup references to sample config in the docs and redirect users to ↵Shay2022-06-302-3/+3
| | | | 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>
* Add custom well-known (#13035)Jacek Kuśnierz2022-06-161-0/+17
| | | Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
* 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-151-2/+4
|
* Prevent local quarantined media from being claimed by media retention (#12972)Andrew Morgan2022-06-071-0/+6
|
* Add config options for media retention (#12732)Andrew Morgan2022-05-311-1/+28
|
* 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-271-0/+3
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-271-0/+3
| | | | | | | | though password authentication is disabled. (#12883)
* | Remove user-visible groups/communities code (#12553)Patrick Cloke2022-05-251-19/+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 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
|
* Fix YAML parsing error in `url_preview_accept_language` (#12785)Andrew Morgan2022-05-181-6/+6
|
* Add some documentation around the `rc_invites` option to the config docs ↵Andrew Morgan2022-05-181-0/+14
| | | | (#12759)
* 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-161-2/+2
|
* Add config flags to allow for cache auto-tuning (#12701)Shay2022-05-131-2/+15
|
* add default_power_level_content_override config option. (#12618)Andy Balaam2022-05-121-0/+26
| | | Co-authored-by: Matthew Hodgson <matthew@matrix.org>
* Reload cache factors from disk on SIGHUP (#12673)David Robertson2022-05-111-0/+17
|
* Update SQL statements in docs for Synapse Admins (#12536)Dirk Klimpel2022-05-091-70/+121
|
* Add `mau_appservice_trial_days` config (#12619)Will Hunt2022-05-041-0/+14
| | | | | | | | | | | | | | | | | | | | | * Add mau_appservice_trial_days * Add a test * Tweaks * changelog * Ensure we sync after the delay * Fix types * Add config statement * Fix test * Reinstate logging that got removed * Fix feature name
* Disable device name lookup over federation by default (#12616)Andrew Morgan2022-05-041-3/+3
|
* Improve logging for cancelled requests (#12587)Sean Quah2022-05-041-1/+1
| | | | | | | Don't log stack traces for cancelled requests and use a custom HTTP status code of 499. Signed-off-by: Sean Quah <seanq@element.io>
* Add a table of contents to config manual (#12527)Shay2022-04-251-2/+44
| | | * Update config_documentation.md
* Add a manual documenting config file options (#12368)Shay2022-04-181-0/+3412
|
* Move scripts directory inside synapse, exposing as setuptools entry_points ↵David Robertson2022-03-021-1/+1
| | | | | | | | | | | | (#12118) * Two scripts are basically entry_points already * Move and rename scripts/* to synapse/_scripts/*.py * Delete sync_room_to_group.pl * Expose entry points in setup.py * Update linter script and config * Fixup scripts & docs mentioning scripts that moved Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* Add admin API to get a list of federated rooms (#11658)Dirk Klimpel2022-01-251-0/+60
|
* Add admin API to reset connection timeouts for remote server (#11639)Dirk Klimpel2022-01-251-1/+39
| | | * Fix get federation status of destination if no error occured
* Document the usage of refresh tokens. (#11427)reivilibre2021-12-081-0/+139
| | | Co-authored-by: David Robertson <davidr@element.io>
* Add admin API to get some information about federation status (#11407)Dirk Klimpel2021-12-061-0/+114
|
* Minor cleanup on recently ported doc pages (#11466)Shay2021-12-023-43/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * move wiki pages to synapse/docs and add a few titles where necessary * update SUMMARY.md with added pages * add changelog * move incorrectly located newsfragment * update changelog number * snake case added files and update summary.md accordingly * update issue/pr links * update relative links to docs * update changelog to indicate that we moved wiki pages to the docs and state reasoning * requested changes to admin_faq.md * requested changes to database_maintenance_tools.md * requested changes to understanding_synapse_through_graphana_graphs.md * add changelog * fix leftover merge errata * fix unwanted changes from merge * use two spaces between entries * outdent code blocks
* Port wiki pages to documentation website (#11402)Shay2021-12-015-0/+385
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * move wiki pages to synapse/docs and add a few titles where necessary * update SUMMARY.md with added pages * add changelog * move incorrectly located newsfragment * update changelog number * snake case added files and update summary.md accordingly * update issue/pr links * update relative links to docs * update changelog to indicate that we moved wiki pages to the docs and state reasoning * revert unintentional change to CHANGES.md * add link Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> * Update CHANGES.md Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* Add an admin API to run background jobs. (#11352)Dirk Klimpel2021-11-191-1/+26
| | | | | | Instead of having admins poke into the database directly. Can currently run jobs to populate stats and to populate the user directory.
* Add documentation page stubs for Single Sign-On, SAML and CAS pages (#11298)Andrew Morgan2021-11-103-0/+21
|
* Add some background update admin APIs (#11263)Erik Johnston2021-11-081-0/+84
| | | Fixes #11259
* Remove false warning about copying the log config to a homeserver.yaml (#11092)Travis Ralston2021-10-201-6/+6
| | | Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* Update doc of the allowed characters for registration tokens (#11093)Dirk Klimpel2021-10-151-1/+1
| | | Co-authored-by: Brendan Abolivier <babolivier@matrix.org>
* Update links to MSCs in documentation (#10991)Dirk Klimpel2021-10-051-1/+2
| | | | Based on matrix-doc switching from master -> main and MSCs being merged.
* Implement MSC3231: Token authenticated registration (#10142)Callum Brown2021-08-211-0/+295
| | | | | Signed-off-by: Callum Brown <callum@calcuode.com> This is part of my GSoC project implementing [MSC3231](https://github.com/matrix-org/matrix-doc/pull/3231).
* Fix some links in `docs` and `contrib` (#10370)Dirk Klimpel2021-07-131-1/+1
|
* A guide to the request log lines format. (#8436)Michael Kaye2021-06-161-0/+44
| | | | | | | This doc is short but a useful guide to what the request log lines mean. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Co-authored-by: Erik Johnston <erik@matrix.org> Co-authored-by: Daniele Sluijters <daenney@users.noreply.github.com>
* Compile and render Synapse's docs into a browsable, mobile-friendly and ↵Andrew Morgan2021-06-036-0/+83
searchable website (#10086)
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-12-24 06:52:53 +0000