summary refs log tree commit diff
path: root/docs/usage (follow)
Commit message (Collapse)AuthorAgeFilesLines
* 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-11-12 13:41:58 +0000