David Robertson
3853011d01
Clarify who isn't affected by rust
2022-09-27 12:34:31 +01:00
David Robertson
3fe2b7f122
tweak upgrade notes
2022-09-27 12:18:40 +01:00
enterprisey
f34b0bc262
Update NixOS module URL ( #13818 )
...
* Update NixOS module URL
* Create 13818.doc
2022-09-26 15:26:59 +01:00
Patrick Cloke
8c3dcdf1b9
Fix the cross-link from register admin API to config docs. ( #13870 )
2022-09-22 09:11:50 -04:00
Peter Scheu
16e1a9d9a7
Correct documentation for map_user_attributes of OpenID Mapping Providers ( #13836 )
...
Co-authored-by: David Robertson <davidr@element.io>
2022-09-21 13:08:16 +00:00
Olivier Wilkinson (reivilibre)
bffb71b04a
Edit changelog in response to feedback
2022-09-20 12:05:15 +01:00
Quentin Gliech
74f60cec92
Add an admin API endpoint to find a user based on its external ID in an auth provider. ( #13810 )
2022-09-16 12:29:03 +00:00
reivilibre
f7a77ad717
Update request log format documentation to mention the format used when the authenticated user is controlling another user. ( #13794 )
2022-09-16 11:48:41 +00:00
Eric Eastwood
6986bcbf39
Document common fix of Poetry problems by removing egg-info ( #13785 )
...
`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.
2022-09-15 16:28:03 -05:00
Eric Eastwood
5093cbf88d
Be able to correlate timeouts in reverse-proxy layer in front of Synapse (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']
```
2022-09-15 15:32:25 -05:00
Erik Johnston
9772e362aa
Merge branch 'master' into develop
2022-09-13 12:11:53 +01:00
Richard van der Hoff
41df25bbbd
installation.md: require libpq on M1 macs ( #13480 )
2022-09-13 09:01:21 +00:00
Brendan Abolivier
7571337445
Fix typo in ratelimiting documentation ( #13727 )
2022-09-12 14:11:18 +01:00
Dirk Klimpel
f799eac7ea
Add timestamp to user's consent ( #13741 )
...
Co-authored-by: reivilibre <olivier@librepush.net>
2022-09-08 15:41:48 +00:00
David Robertson
a7c71686ca
Add minimum version bump for sqlite to the release notes ( #13742 )
...
* Notify that SQLite min version will be bumped
* Mention in upgrade notes
Co-authored-by: reivilibre <oliverw@matrix.org>
2022-09-08 12:00:03 +01:00
David Robertson
c46fecd1f2
Correct out-of-date doc for event_cache_size
( #13726 )
2022-09-07 14:46:11 +01:00
David Robertson
77f3986451
Define SQLite compat policy ( #13728 )
2022-09-07 12:07:42 +00:00
Connor Davis
bb5b47b62a
Add Admin API to Fetch Messages Within a Particular Window ( #13672 )
...
This adds two new admin APIs that allow us to fetch messages from a room within a particular time.
2022-09-07 10:54:44 +01:00
Erik Johnston
c9b7e97355
Add a stub Rust crate ( #12595 )
2022-09-06 19:01:37 +01:00
Erik Johnston
571f565c1f
Update changelog
2022-09-06 09:25:32 +01:00
Patrick Cloke
32fc3b7ba4
Remove configuration options for direct TCP replication. ( #13647 )
...
Removes the ability to configure legacy direct TCP replication. Workers now require Redis to run.
2022-09-06 07:50:02 +00:00
Eric Eastwood
877bdfa889
Clarify (room_id, event_id)
global uniqueness ( #13701 )
...
Summarized from @richvdh's reply at https://github.com/matrix-org/synapse/pull/13589#discussion_r961116999
2022-09-02 14:05:39 -05:00
Eric Eastwood
36b184b782
Update docs to make enabling metrics more clear ( #13678 )
...
It was really easy to miss the `enable_metrics: True` step with the previous language.
2022-09-02 11:29:51 -05:00
Erik Johnston
4fee4a339d
Update lock file for Poetry v1.2.0 ( #13689 )
2022-09-02 13:20:03 +00:00
Dirk Klimpel
044900af6c
Fix two typos with colon in headlines ( #13665 )
2022-09-01 20:38:37 +00:00
Will Hunt
c913e440c0
Add monthly active users documentation ( #13617 )
...
* 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>
2022-09-01 14:48:43 +00:00
Sean Quah
737968b8e0
Merge branch 'master' into develop
2022-08-31 13:56:50 +01:00
Sean Quah
d1fb46fbc9
Improve clarity on deprecation of TCP replication
...
Borrows some text from https://github.com/matrix-org/synapse/pull/13647
for the changelog.
2022-08-31 12:19:40 +01:00
Sean Quah
90c99fb3aa
Fix dead link in 1.18.0 upgrade notes
2022-08-31 11:53:30 +01:00
Richard van der Hoff
372136d3a8
Remove documentation of legacy frontend_proxy
worker app ( #13645 )
...
This has been the same as a generic_worker since #6964 , so let's get rid of it.
Fixes #3717
2022-08-30 18:01:51 +01:00
Patrick Cloke
e761e8b475
Clarify documentation about replication traffic. ( #13656 )
...
It can be authenticated with the worker_replication_secret setting,
but is always unencrypted.
2022-08-30 12:21:19 +00:00
Richard van der Hoff
c4e29b6908
Improve documentation around user registration ( #13640 )
...
Update a bunch of the documentation for user registration, add some cross
links, etc.
2022-08-26 13:29:31 +00:00
Richard van der Hoff
5e5c8150d7
Generate missing configuration files at startup ( #13615 )
...
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.
2022-08-26 11:26:06 +00:00
Richard van der Hoff
d092e6f32a
Support registration_shared_secret
in a file ( #13614 )
...
A new `registration_shared_secret_path` option. This is kinda handy for k8s deployments and things.
2022-08-25 16:27:46 +00:00
David Robertson
a25a37002c
Write about the chain cover a little. ( #13602 )
...
Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
2022-08-23 17:41:55 +00:00
nilsKr3
bdfff9c36e
Update openid.md ( #13568 )
...
Linking the help article may prevent confusion regarding the creation of the necessary rule using auth0.
2022-08-23 14:34:10 +01:00
David Robertson
956e015413
Drop support for delegating email validation, round 2 ( #13596 )
2022-08-23 11:40:00 +00:00
David Robertson
d6f5699737
Describe changes to admin API in 1.66
...
Cross-ref #13525
2022-08-23 10:09:45 +01:00
Andrew Morgan
f9f03426de
Implement MSC3852: Expose last_seen_user_agent
to users for their own devices; also expose to Admin API ( #13549 )
2022-08-19 16:17:10 +00:00
Ayush Anand
22ea51faf9
Add support for compression to federation responses ( #13537 )
...
Closes #13415 .
Signed-off-by: Ayush Anand <iamayushanand@gmail.com>
2022-08-18 15:14:47 +01:00
David Robertson
82a0752f32
A first pass at pruning the Synapse README ( #13491 )
2022-08-17 16:46:09 +01:00
Antonin Loubiere
b71b41c7bd
Fix a typo in docs and in some warnings ( #13538 )
2022-08-17 10:59:05 +01:00
Dirk Klimpel
d75512d19e
Add forgotten status to Room Details API ( #13503 )
2022-08-17 09:42:01 +00:00
Dirk Klimpel
14e673ef9d
Add missing links in user_consent
section of configuration manual ( #13536 )
...
Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
2022-08-16 16:20:56 +01:00
Shay
73c83c6411
Add a warning to retention documentation regarding the possibility of database corruption ( #13497 )
2022-08-15 11:54:23 -07:00
James Barton
e825f7366b
Add openssl
example for registration HMAC ( #13472 )
...
Signed-off-by: James Barton <james@neodon.com>
2022-08-11 21:10:10 +01:00
Andrew Morgan
953df2ad88
Add note to redaction_retention_period
documentation mentioning that event purging runs at most every 5m ( #13492 )
2022-08-11 14:06:09 +01:00
Dirk Klimpel
70d3e70009
Make the configuration for the cache clearer ( #13481 )
2022-08-09 11:30:22 +01:00
Julian-Samuel Gebühr
3d2cabf966
Mark token-authenticaticated-registration API as not-experimental ( #11897 )
2022-08-05 11:15:35 +00:00
Dirk Klimpel
6dd7fa12dc
Update some outdated information on sso_mapping_providers.md
( #13449 )
2022-08-04 13:06:02 +01:00
Dirk Klimpel
afbdbe0634
Fix return value in example on password_auth_provider_callbacks.md
( #13450 )
...
Fixes : #12534
Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
2022-08-04 13:03:36 +01:00
jejo86
668597214f
Improve documentation on becoming server admin ( #13230 )
...
* 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>
2022-08-03 11:15:23 +01:00
Dirk Klimpel
fb7a2cc4cc
Update doc for setting macaroon_secret_key
( #13443 )
...
* Update doc for setting `macaroon_secret_key`
* newsfile
2022-08-03 10:41:19 +01:00
Dirk Klimpel
5eccfdfafd
Remove 'Contents' section from the Configuration Manual ( #13438 )
...
Fixes : #13053
2022-08-03 09:19:20 +00:00
Dirk Klimpel
ec6758d472
Fix wrong headline for url_preview_accept_language
in docs ( #13437 )
...
Fixes : #13433
2022-08-03 09:41:57 +01:00
Olivier Wilkinson (reivilibre)
a2a867b521
Merge branch 'master' into develop
2022-08-02 11:56:02 +01:00
Olivier Wilkinson (reivilibre)
cb209638ea
Add upgrade notes
2022-08-02 11:10:26 +01:00
Richard van der Hoff
d548d8f18d
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 ))
-----BEGIN PGP SIGNATURE-----
iQEzBAABCgAdFiEEv27Axt/F4vrTL/8QOSor00I9eP8FAmLj4a8ACgkQOSor00I9
eP8biQf/c8yY2mbeRZcBKtp6yoQCRYQvboSMEXyi+dLe1hNqdhSZwRQcAoFuAFwE
WdScDvoTaElUxv0v6eCI1x9CoXnZ6xpDShvK39j5Yhzv+1tNsm5Uq9imyG3jK5i6
U/3Gt6CrCsS01VkGslQ3B5I6MFtbC6ZZK9O48yg+GD8Oqw2HH/gllr5swyVbKdbc
GGhRBHvgXn+w6d/KnKt8uRxJqIpDt9JMga+WdB8CwFR5WnWbGdw24KsyxmBuOLC3
caQRiluJL/X4jApUpfsJMBBd/jrDod5wWDFO/4P+v0+2d3Ts+hKezZbt5h1VIYSw
szZXbzxn5RNDkNiJDpOOOMYQ5DXGmA==
=3/nK
-----END PGP SIGNATURE-----
Merge tag 'v1.64.0rc2' into develop
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 ))
2022-07-29 15:15:21 +01:00
3nprob
98fb610cc0
Revert "Drop support for delegating email validation ( #13192 )" ( #13406 )
...
Reverts commit fa71bb18b5
, and tweaks documentation.
Signed-off-by: 3nprob <git@3n.anonaddy.com>
2022-07-29 10:29:23 +00:00
Brendan Abolivier
24ef1460f6
Explicitly mention which resources support compression in the config guide ( #13221 )
2022-07-29 09:09:57 +00:00
Matt Holt
935e73efed
Update Caddy reverse proxy documentation ( #13344 )
...
Improve/simplify Caddy examples. Remove Caddy v1 (has long been EOL'ed)
Signed-off-by: Matthew Holt <mholt@users.noreply.github.com>
2022-07-25 16:07:26 +00:00
Jan Schär
e8519e0ed2
Support Implicit TLS for sending emails ( #13317 )
...
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>
2022-07-25 16:27:19 +01:00
Richard van der Hoff
c7c84b81e3
Update config_documentation.md ( #13364 )
...
"changed in" goes before the example
2022-07-22 13:50:20 +01:00
Sean Quah
0fa41a7b17
Update locked frozendict version to 2.3.3 ( #13352 )
...
frozendict 2.3.3 includes fixes for memory leaks that get triggered during `/sync`.
2022-07-22 10:26:09 +01:00
David Robertson
4f57ef0b18
Merge branch 'master' into develop
2022-07-21 11:27:08 +01:00
David Teller
b909d5327b
Document rc_invites.per_issuer
, added in v1.63.
...
Resolves #13330 .
Missed in #13125 .
Signed-off-by: David Teller <davidt@element.io>
2022-07-21 11:26:34 +01:00
Brendan Abolivier
47822fd2e8
Merge branch 'master' into develop
2022-07-19 16:14:02 +02:00
Andrew Morgan
6faaf76a32
Remove 'anonymised' from the phone home stats documentation ( #13321 )
2022-07-19 12:38:29 +00:00
Jörg Behrmann
87a917e8c8
Add notes when config options were changed to config documentation ( #13314 )
...
Signed-off-by: Jörg Behrmann <behrmann@physik.fu-berlin.de>
2022-07-19 12:36:29 +00:00
David Robertson
b977867358
Rate limit joins per-room ( #13276 )
2022-07-19 11:45:17 +00:00
David Robertson
e9ce4d089b
Use and recommend poetry 1.1.14, up from 1.1.12 ( #13285 )
2022-07-15 16:18:47 +01:00
jejo86
2341032cf2
Document advising against publicly exposing the Admin API and provide a 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>
2022-07-13 19:33:33 +01:00
Patrick Cloke
1381563988
Inline URL preview documentation. ( #13261 )
...
Inline URL preview documentation near the implementation.
2022-07-12 15:01:58 -04:00
Richard van der Hoff
fa71bb18b5
Drop support for delegating email validation ( #13192 )
...
* 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
2022-07-12 19:18:53 +01:00
Shay
6f30eb5b8e
Add info about configuration in the url preview docs ( #13233 )
...
Cross-link doc pages for easier navigation.
2022-07-12 13:48:47 -04:00
andrew do
2d82cdafd2
expose whether a room is a space in the Admin API ( #13208 )
2022-07-12 15:30:53 +01:00
Andrew Morgan
5ef2f87569
Document the 'databases' homeserver config option ( #13212 )
2022-07-11 14:05:24 +00:00
reivilibre
fb7d24ab6d
Check that auto_vacuum
is disabled when porting a SQLite database to Postgres, as VACUUM
s must not be performed between runs of the script. ( #13195 )
2022-07-07 10:08:04 +00:00
Patrick Cloke
dcc7873700
Add information on how the Synapse team does reviews. ( #13132 )
2022-07-06 07:30:58 -04:00
reivilibre
65e675504f
Add the ability to set the log level using the SYNAPSE_TEST_LOG_LEVEL
environment when using complement.sh
. ( #13152 )
2022-07-05 09:46:20 +00:00
Dirk Klimpel
e514495465
Add missing links to config options ( #13166 )
2022-07-05 10:10:26 +01:00
Andrew Morgan
c0efc689cb
Add documentation for phone home stats ( #13086 )
2022-06-30 22:12:28 +01:00
Shay
8330fc9953
Cleanup references to sample config in the docs and redirect users to configuration manual ( #13077 )
2022-06-30 09:21:39 -07:00
Andrew Morgan
0ceb3af10b
Add a link to the configuration manual from the homeserver sample config documentation page ( #13139 )
2022-06-30 15:59:11 +01:00
Moritz Stückler
e714b8a057
Fix documentation header for allow_public_rooms_over_federation
( #13116 )
...
Signed-off-by: Moritz Stückler <moritz.stueckler@gmail.com>
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
2022-06-29 18:41:39 +02:00
jejo86
cdc0259449
Document the --report-stats
argument ( #13029 )
...
Signed-off-by: jejo86 <28619134+jejo86@users.noreply.github.com>
2022-06-29 10:24:10 +01:00
Aaron Raimist
3ceaf1462d
Remove docs for Delete Group Admin API ( #13112 )
...
This API no longer exists.
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2022-06-27 11:15:25 +01:00
Shay
3d94d07db3
Update opentracing docs to reference the configuration manual rather than the configuation file. ( #13076 )
2022-06-17 10:47:38 -07:00
Richard van der Hoff
5d6f55959e
Update info on downstream debs ( #13095 )
2022-06-17 12:47:22 +01:00
Jacek Kuśnierz
0ef1307619
Add custom well-known ( #13035 )
...
Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
2022-06-16 11:48:18 +01:00
reivilibre
ffe2464836
Add instructions for running Complement with gotestfmt
-formatted output locally. ( #13073 )
2022-06-16 09:31:10 +00:00
Shay
cba1c5cbc2
Add headers to individual options in config documentation to allow for linking. ( #13055 )
2022-06-15 11:31:46 -07:00
Erik Johnston
c95b04bb0e
Change default sync_response_cache_duration
( #13042 )
2022-06-15 16:55:20 +00:00
Hannes Lerchl
7d99414edf
Replace pyjwt with authlib in org.matrix.login.jwt
( #13011 )
2022-06-15 16:45:16 +00:00
Brendan Abolivier
bdb6628dcf
Fix version number in spam checker callbacks doc ( #13047 )
2022-06-14 17:24:25 +02:00
Shay
493c2fc44a
Remove code generating comments in configuration file ( #12941 )
2022-06-14 07:53:42 -07:00
Erik Johnston
5d139f578d
Merge branch 'release-v1.61' into develop
2022-06-14 12:00:02 +01:00
Erik Johnston
b8bf61230c
Fixup upgrades
2022-06-14 11:56:45 +01:00
Sami Olmari
7b54badd31
Mention removed community/group worker endpoints in upgrade.md ( #13023 )
2022-06-14 11:40:02 +01:00
Sami Olmari
a542a92c57
Mention removed community/group worker endpoints in upgrade.md ( #13023 )
2022-06-14 11:35:22 +01:00