Commit Graph

128 Commits

Author SHA1 Message Date
Evan Krall
1cd4fbc51d
Correct documentation about registration_shared_secret_path ()
* 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>
2023-02-28 11:09:31 +00:00
Centzilius
1a1738eca2
Fix typo in federation_verify_certificates in config documentation. () 2023-02-23 13:25:56 -05:00
Dirk Klimpel
a068ad7dd4
Add information on uploaded media to user export command. () 2023-02-23 13:14:17 -05:00
Patrick Cloke
4ed08ff72e
Tighten the default rate limit of creating new devices. () 2023-02-22 14:37:18 -05:00
jahway603
356ea4e09b
Update database_maintenance_tools.md ()
* 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
2023-02-20 14:29:13 +00:00
Dirk Klimpel
61bfcd669a
Add account data to export command ()
* Add account data to to export command

* newsfile

* remove not needed function

* update newsfile

* adopt 
2023-02-17 13:54:55 +00:00
saddfox
d1efc47925
Fix a mistake in registration_shared_secret_path docs ()
* fix a typo in registration_shared_secret_path docs
Signed-off-by: Filip Rutar <filip.rutar@gmail.com>

* changelog
2023-02-15 19:51:58 +00:00
999lakhisidhu
27a3a72a50
Support for selecting the Redis logical database. ()
Note that this is only used for key-value store (cached values)
and not for the pub/sub replication used by Synapse.
2023-02-15 07:39:31 -05:00
Dirk Klimpel
bf82b56bab
Add more user information to export-data command. ()
* The user's profile information.
* The user's devices.
* The user's connections / IP address information.
2023-02-01 15:45:19 +00:00
ZAID BIN TARIQ
b15f0758e5
Document the export user data command. () 2023-01-25 07:01:27 -05:00
Richard van der Hoff
2069231645
Update logging_sample_config.md ()
You do not have to restart synapse to reload the log config.
2023-01-19 11:58:17 +00:00
Catalan Lover
e8f2bf5c40
Change default room version to 10. Implements MSC3904 ()
* 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>
2023-01-18 18:59:48 +00:00
Tejaswini Gurram
1416096527
Update misleading documentation user_directory.search_all_users ()
Fixes 
2023-01-13 14:46:21 +00:00
Dirk Klimpel
1caf16a450
Add worker_manhole to configuration manual ()
Closes: 
2023-01-13 14:14:39 +00:00
Dirk Klimpel
73f097888e
Add listener health ()
Fixes: 
2023-01-11 12:00:38 +00:00
Dirk Klimpel
bc7ca704dd
Add tag to listeners documentation ()
* Add `tag` to `listeners` documentation

* newsfile
2023-01-11 10:47:44 +00:00
Dirk Klimpel
3479599387
Add missing worker settings to shared configuration ()
* 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>
2023-01-09 18:35:19 +00:00
reivilibre
4eb2f4e02b
Fix broken links in the Synapse documentation. ()
* 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>
2023-01-05 18:18:00 +00:00
Patrick Cloke
630d0aeaf6
Support RFC7636 PKCE in the OAuth 2.0 flow. ()
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.
2023-01-04 14:58:08 -05:00
Patrick Cloke
906dfaa2cf
Support non-OpenID compliant user info endpoints ()
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.
2023-01-04 08:26:10 -05:00
Dirk Klimpel
2fb4071c1f
Move email to Server section in config file documentation ()
* Move `email` to server in config file documentation

* changelog
2022-12-28 12:17:51 +00:00
Jeremy Kescher
046320b9b6
Fix missing word in autotune sub-option description ()
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>
2022-12-14 20:03:13 -08:00
David Robertson
e2a1adbf5d
Allow selecting "prejoin" events by state keys ()
* 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 

* Add extra methods to StateFilter

* Use StateFilter

* Ensure test file enforces typed defs; alphabetise

* Workaround surprising get_current_state_ids

* Whoops, fix mypy
2022-12-13 00:54:46 +00:00
Richard van der Hoff
dfe8febe47
Update admin_faq.md 2022-12-07 22:02:20 +00:00
Will Hunt
e1779bc69f
Fix push.enabled config documentation ()
* Fix push.enabled config documentation

* Create 14619.doc

* Update 14619.doc
2022-12-05 12:47:45 +00:00
realtyem
6acb6d772a
Update worker docs to update preferred settings for pusher and federation_sender ()
* 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.
2022-12-02 11:38:01 +00:00
Will Hunt
71f3e53ad0
Add push.enabled option to disable push notification calculation ()
* Add initial option

* changelog

* Some more linting
2022-12-01 13:46:24 +00:00
Ashish Kumar
09de2aecb0
Add support for handling avatar with SSO login ()
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 .
2022-11-25 15:16:50 +00:00
reivilibre
9af2be192a
Remove legacy Prometheus metrics names. They were deprecated in Synapse v1.69.0 and disabled by default in Synapse v1.71.0. () 2022-11-24 09:09:17 +00:00
Brennan Chapman
640cb3c81c
Fix broken admin API request recommendation link ()
Signed-off-by: Brennan Chapman <brennan@chapmanb.com>
2022-11-21 12:40:25 +01:00
Tuomas Ojamies
b5ab2c428a
Support using SSL on worker endpoints. ()
* 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>
2022-11-15 12:55:00 +00:00
Will Hunt
b1379a7ca8
Update legacy synapse_admin_mau: metric names in docs ()
* Rename legacy metrics in MAU docs

* changelog
2022-11-03 20:47:20 +00:00
reivilibre
6546308c1e
Disable legacy Prometheus metric names by default. They can still be re-enabled for now, but they will be removed altogether in Synapse 1.73.0. () 2022-11-02 17:33:45 +00:00
Quentin Gliech
cc3a52b33d
Support OIDC backchannel logouts ()
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.
2022-10-31 13:07:30 -04:00
Dirk Klimpel
44f0d573cf
Add docs for an empty trusted_key_servers config option ()
* Add docs for an empty `trusted_key_servers` config option

* small rewording

* Tweak changelog
2022-10-28 13:55:03 +01:00
Dirk Klimpel
1357ae869f
Add workers settings to configuration manual ()
* 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>
2022-10-27 14:39:47 +01:00
Matthew Hodgson
695a85d1bc
Document encryption_enabled_by_default_for_room_type under the right name ()
* document encryption_enabled_by_default_for_room_type under the right name

* add changelog

* Update changelog.d/14110.doc
2022-10-19 20:17:37 +01:00
David Robertson
cd01a1d3b5
Fix dead link to admin registration API ()
* Fix dead link to admin registration API

* Changelog
2022-10-17 12:10:01 +01:00
Andrew Morgan
e580f03e02
Fix name of "alias_creation_rules" option in config manual () 2022-10-10 20:01:05 +00:00
David Robertson
0c853e0970
Fix broken links to README () 2022-10-06 22:49:51 +00:00
Akshit Tyagi
1613857b90
Linkify config documentation. () 2022-10-04 09:03:31 +00:00
reivilibre
b381701f8c
Announce that legacy metric names are deprecated, will be turned off by default in Synapse v1.71.0 and removed altogether in Synapse v1.73.0. () 2022-10-03 17:16:15 +00:00
Andrew Morgan
25c0e69392
Document that the 'auto_join_rooms' option works with Spaces () 2022-09-28 14:13:19 +00:00
reivilibre
f7a77ad717
Update request log format documentation to mention the format used when the authenticated user is controlling another user. () 2022-09-16 11:48:41 +00:00
Eric Eastwood
5093cbf88d
Be able to correlate timeouts in reverse-proxy layer in front of Synapse (pull request ID from header) ()
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']
```
2022-09-15 15:32:25 -05:00
Brendan Abolivier
7571337445
Fix typo in ratelimiting documentation () 2022-09-12 14:11:18 +01:00
David Robertson
c46fecd1f2
Correct out-of-date doc for event_cache_size () 2022-09-07 14:46:11 +01:00
Patrick Cloke
32fc3b7ba4
Remove configuration options for direct TCP replication. ()
Removes the ability to configure legacy direct TCP replication. Workers now require Redis to run.
2022-09-06 07:50:02 +00:00
Dirk Klimpel
044900af6c
Fix two typos with colon in headlines () 2022-09-01 20:38:37 +00:00
Will Hunt
c913e440c0
Add monthly active users documentation ()
* Add monthly active users documentation

* changelog

* Tidy up notes

* more tidyup

* Rewrite 

* 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>
2022-09-01 14:48:43 +00:00