4d408cb4dd
Note preset behaviour in `autocreate_auto_join_room_preset` docs ( #17150 )
2024-05-08 13:05:10 +01:00
1b155362ca
Add note about external_ids for User Admin API in documentation ( #17139 )
2024-05-07 16:38:29 +00:00
5b6a75935e
upgrade.md: Bump minimum Rust version to 1.66.0 (element-hq#17079) ( #17140 )
...
upgrade.md: Bump minimum Rust version to 1.66.0 (element-hq#17079)
2024-05-02 14:57:29 +01:00
7ab0f630da
Apply user `email` & `picture` during OIDC registration if present & selected ( #17120 )
...
This change will apply the `email` & `picture` provided by OIDC to the
new user account when registering a new user via OIDC. If the user is
directed to the account details form, this change makes sure they have
been selected before applying them, otherwise they are omitted. In
particular, this change ensures the values are carried through when
Synapse has consent configured, and the redirect to the consent form/s
are followed.
I have tested everything manually. Including:
- with/without consent configured
- allowing/not allowing the use of email/avatar (via
`sso_auth_account_details.html`)
- with/without automatic account detail population (by un/commenting the
`localpart_template` option in synapse config).
### Pull Request Checklist
<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->
* [X] Pull request is based on the develop branch
* [X] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog ).
The entry should:
- Be a short description of your change which makes sense to users.
"Fixed a bug that prevented receiving messages from other servers."
instead of "Moved X method from `EventStore` to `EventWorkerStore`.".
- Use markdown where necessary, mostly for `code blocks`.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by
@github_username." or "Contributed by [Your Name]." to the end of the
entry.
* [X] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html ) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters ))
2024-04-29 15:23:05 +00:00
0fd6b269d3
Fix various typos in docs ( #17114 )
...
### Pull Request Checklist
<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->
* [X] Pull request is based on the develop branch
* [X] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog ).
The entry should:
- Be a short description of your change which makes sense to users.
"Fixed a bug that prevented receiving messages from other servers."
instead of "Moved X method from `EventStore` to `EventWorkerStore`.".
- Use markdown where necessary, mostly for `code blocks`.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by
@github_username." or "Contributed by [Your Name]." to the end of the
entry.
* [X] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html ) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters ))
2024-04-26 18:10:45 +00:00
9c91873922
Add RuntimeDirectory to matrix-synapse.service ( #17084 )
...
This makes it easy to store UNIX sockets with correct permissions. Those
would be located in /run/synapse which is the directory used in many
examples in Synapse configuration manual. Additionally, the directory
and sockets are deleted when Synapse is shut down.
2024-04-26 09:56:20 +01:00
90cc9e5b29
Rephrase enable_notifs configuration ( #17116 )
2024-04-26 09:52:58 +01:00
516fd891ee
Use recommended endpoint for MSC3266 requests ( #17078 )
...
Keep the existing endpoint for backwards compatibility
Signed-off-by: Andrew Ferrazzutti <andrewf@element.io>
2024-04-26 09:46:42 +01:00
0ef2315a99
Update event_cache_size and global_factor configurations documentation ( #17071 )
...
### Pull Request Checklist
<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->
* [x] Pull request is based on the develop branch
* [x] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog ).
The entry should:
- Be a short description of your change which makes sense to users.
"Fixed a bug that prevented receiving messages from other servers."
instead of "Moved X method from `EventStore` to `EventWorkerStore`.".
- Use markdown where necessary, mostly for `code blocks`.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by
@github_username." or "Contributed by [Your Name]." to the end of the
entry.
* [x] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html ) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters ))
2024-04-26 09:44:54 +01:00
074ef4d75f
Add an OSX prompt to manually configure icu4c. ( #17069 )
...
Documentation fix.
2024-04-19 17:10:44 +01:00
301c9771c4
Clarify what part of message retention is still experimental ( #17099 )
...
### Pull Request Checklist
<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->
* [X] Pull request is based on the develop branch
* [x] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog ).
The entry should:
- Be a short description of your change which makes sense to users.
"Fixed a bug that prevented receiving messages from other servers."
instead of "Moved X method from `EventStore` to `EventWorkerStore`.".
- Use markdown where necessary, mostly for `code blocks`.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by
@github_username." or "Contributed by [Your Name]." to the end of the
entry.
* [X] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html ) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters ))
2024-04-19 15:26:28 +00:00
fd48fc4585
Fixups to new push stream ( #17038 )
...
Follow on from #17037
2024-03-28 16:29:23 +00:00
ea6bfae0fc
Add support for moving `/push_rules` off of main process ( #17037 )
2024-03-28 15:44:07 +00:00
b7af076ab5
Add OIDC config to add extra parameters to the authorize URL ( #16971 )
2024-03-22 10:35:11 +00:00
5a59c68b3d
Remove the hardcoded poetry version from contributing guide ( #17002 )
2024-03-21 17:12:02 +00:00
6cf23febb9
Add note to using --curses under sqlite porting ( #17012 )
2024-03-21 17:07:21 +00:00
159536d525
Update link, in installation guide, for docker hub synapse images ( #17001 )
2024-03-21 17:05:52 +00:00
74ab329eaa
Pass module API to OIDC mapping provider ( #16974 )
...
As done for SAML mapping provider, let's pass the module API to the OIDC
one so the mapper can do more logic in its code.
2024-03-19 17:20:10 +00:00
1198f649ea
Sort versions in the documentation version picker appropriately. ( #16966 )
...
Fixes #16964
This adds a proper sorter for versions which takes into account semantic
versions, rather than just relying on localeCompare.
2024-03-14 15:18:51 +00:00
acc2f00eca
upgrade.md: fix grammatical errors ( #16965 )
...
comma splice
"rollback" is a noun
2024-03-14 13:54:01 +00:00
1c1b0bfa77
Add query to update local cache of a remote user's device list to docs ( #16892 )
2024-03-14 13:53:25 +00:00
48f59d3806
deactivated flag refactored to filter deactivated users. ( #16874 )
...
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2024-03-11 16:08:04 +00:00
4af33015af
Fix joining remote rooms when a `on_new_event` callback is registered ( #16973 )
...
Since Synapse 1.76.0, any module which registers a `on_new_event`
callback would brick the ability to join remote rooms.
This is because this callback tried to get the full state of the room,
which would end up in a deadlock.
Related:
https://github.com/matrix-org/synapse-auto-accept-invite/issues/18
The following module would brick the ability to join remote rooms:
```python
from typing import Any, Dict, Literal, Union
import logging
from synapse.module_api import ModuleApi, EventBase
logger = logging.getLogger(__name__)
class MyModule:
def __init__(self, config: None, api: ModuleApi):
self._api = api
self._config = config
self._api.register_third_party_rules_callbacks(
on_new_event=self.on_new_event,
)
async def on_new_event(self, event: EventBase, _state_map: Any) -> None:
logger.info(f"Received new event: {event}")
@staticmethod
def parse_config(_config: Dict[str, Any]) -> None:
return None
```
This is technically a breaking change, as we are now passing partial
state on the `on_new_event` callback.
However, this callback was broken for federated rooms since 1.76.0, and
local rooms have full state anyway, so it's unlikely that it would
change anything.
2024-03-06 16:00:20 +01:00
8de3283ebe
Add docs on upgrading from a very old version ( #16951 )
...
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2024-02-22 17:36:41 +00:00
7c1c011942
Add HAProxy example for single port operation ( #16768 )
2024-02-20 16:15:58 +00:00
1b7304c8b4
fix typo in admin_api/rooms.md ( #16857 )
...
Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
2024-02-20 12:20:23 +00:00
93edd0932e
Update docs for MacOS installs ( #16854 )
...
ICU is an optional dependency and also a pain to install. Mention that
you can just not install it and still get a working installation.
2024-02-06 09:27:38 +00:00
505cdd044b
Fix broken links on docs ( #16853 )
...
Some links seemed to be incorrect (vector-im/sygnal and vector-im/sytest
have never been A Thing iirc) so pointed them back to matrix-org/*).
2024-02-06 09:26:55 +00:00
d24d115706
Update version picker for element-hq ( #16880 )
2024-02-01 14:30:16 +00:00
8459ac9be2
listen http2 deprecated nginx (updating documentation) ( #16831 )
...
More info [here](https://www.nginx.com/blog/nginx-plus-r30-released/ ).
Nginx threw error's at me when I used all the options of the doc
2024-01-22 14:22:16 +00:00
a68b48a5dd
Allow room creation but not publishing to continue if room publication rules are violated when creating a new room. ( #16811 )
...
Prior to this PR, if a request to create a public (public as in
published to the rooms directory) room violated the room list
publication rules set in the
[config](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#room_list_publication_rules ),
the request to create the room was denied and the room was not created.
This PR changes the behavior such that when a request to create a room
published to the directory violates room list publication rules, the
room is still created but the room is not published to the directory.
2024-01-22 13:59:45 +00:00
3fefb15fef
Bump minimum Rust version to 1.65.0 ( #16818 )
...
The ecosystem e.g. regex crate, have bumped up their MSRV to 1.65.0,
which was released Nov 2022. In line with our policy, let's bump to
match.
2024-01-22 11:11:52 +00:00
f95cfd898e
Fix broken links in issue template ( #16810 )
...
This happened during the migration
2024-01-17 13:40:00 +00:00
13e3740f70
Add a link to the Request log format page from Logging Sample Config ( #16778 )
2024-01-10 13:34:55 +00:00
798a507ee0
Update the contributing guide after reliecensing ( #16772 )
2024-01-03 11:31:03 +00:00
35b6365317
Add another custom statistics collection server ( #16769 )
...
Signed-off-by: Christian Lölkes <christian.loelkes@gmail.com>
2024-01-02 11:54:12 +00:00
14ed84ac33
Enable user without password ( #16770 )
...
Closes:
- https://github.com/matrix-org/synapse/issues/10397
- #10397
An administrator should know whether he wants to set a password or not.
There are many uses cases where a blank password is required.
- Use of only some users with SSO.
- Use of bots with password, users with SSO
2024-01-02 11:52:51 +00:00
c1fe945dd5
Remove config value from header ( #16763 )
...
Signed-off-by: Fredrik Lanker <fredrik@lanker.se>
2024-01-02 11:50:50 +00:00
719014d9d5
Fix sample config doc CI ( #16758 )
...
I accidentally broke it during the move by removing a trailing new line.
2023-12-21 13:31:19 +00:00
930dc9e2d3
Fix typo
2023-12-13 16:37:10 +00:00
0455c40085
Update book location
2023-12-13 16:15:22 +00:00
8613f7693e
More renaming
2023-12-13 15:41:11 +00:00
188a51daa9
Keep pointing at packages.matrix.org for now
2023-12-13 15:18:58 +00:00
837391cdbb
Update documentation to refer to element-hq.
2023-12-13 15:16:48 +00:00
e85e0ef6ba
Merge remote-tracking branch 'origin/master' into develop
2023-12-12 17:37:17 +00:00
e108cde669
Sentry Alert configuration based on production and development environment ( #16738 )
2023-12-12 16:04:41 +00:00
e108c31fc0
Add avatar and topic settings for server notice room ( #16679 )
2023-12-12 15:22:19 +00:00
9f6c644825
Add config to change the delay before sending a notification email ( #16696 )
2023-12-12 10:28:56 +00:00
ee37039031
Version picker added for v1.98 docs
2023-12-11 14:51:26 +00:00
483d22afc3
Adding a version picker for Synapse docs ( #16533 )
2023-12-11 14:18:40 +00:00
aa983c7b0f
Clarify documentation for `only_for_reauth` ( #16737 )
2023-12-07 17:52:50 +00:00
e87499b3f4
Add how to validate configuration file with synapse.config script ( #16714 )
2023-12-05 11:42:56 +00:00
0aa4d3b6f7
Switch UNIX socket paths to /run, and add a UNIX socket example for HAProxy ( #16700 )
2023-12-04 12:38:46 +00:00
9e7f80037d
Server notices: add an autojoin setting for the notices room ( #16699 )
...
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
2023-12-04 12:31:42 +00:00
63d96bfc61
ModuleAPI SSO auth callbacks ( #15207 )
...
Signed-off-by: Andrii Yasynyshyn yasinishyn.a.n@gmail.com
2023-12-01 14:31:50 +00:00
77882b6a7d
Document which versions of Synapse have compatible schema versions. ( #16661 )
2023-11-28 11:01:24 -05:00
8751f0ef32
Fix poetry version typo in contributors' guide ( #16695 )
2023-11-27 15:16:20 +00:00
518e4de758
Update admin user API return types in docs. ( #16654 )
2023-11-17 13:38:25 +00:00
43d1aa75e8
Add an Admin API to temporarily grant the ability to update an existing cross-signing key without UIA ( #16634 )
2023-11-15 17:28:10 +00:00
999bd77d3a
Asynchronous Uploads ( #15503 )
...
Support asynchronous uploads as defined in MSC2246.
2023-11-15 09:19:24 -05:00
80922dc46e
Add links to pre-1.0 changelog issue/PR references. ( #16638 )
2023-11-15 13:31:24 +00:00
4dd18bdc2e
Improve documentation for `/_synapse/admin/v1/rooms/<room_id>/timestamp_to_event` ( #16631 )
2023-11-14 11:43:44 -05:00
fb2554b11f
Fix outbound_federation_restricted_to docs & note when added ( #16628 )
2023-11-13 14:26:49 +00:00
bc4372ad81
Use dbname instead of database for Postgres config. ( #16618 )
2023-11-09 14:40:45 -05:00
c02406ac71
Add new module API for adding custom fields to events `unsigned` section ( #16549 )
2023-10-27 09:04:08 +00:00
85e5f2dc25
Add a new module API to update user presence state. ( #16544 )
...
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).
2023-10-26 15:11:24 -04:00
c14a7de6af
Pin the recommended poetry version in contributors' guide ( #16550 )
2023-10-25 16:31:15 +01:00
6ec98810e3
Rework alias and public room list rules docs ( #16541 )
2023-10-24 13:26:41 +01:00
8f35f8148e
Fix bug where a new writer advances their token too quickly ( #16473 )
...
* Fix bug where a new writer advances their token too quickly
When starting a new writer (for e.g. persisting events), the
`MultiWriterIdGenerator` doesn't have a minimum token for it as there
are no rows matching that new writer in the DB.
This results in the the first stream ID it acquired being announced as
persisted *before* it actually finishes persisting, if another writer
gets and persists a subsequent stream ID. This is due to the logic of
setting the minimum persisted position to the minimum known position of
across all writers, and the new writer starts off not being considered.
* Fix sending out POSITIONs when our token advances without update
Broke in #14820
* For replication HTTP requests, only wait for minimal position
2023-10-23 16:57:30 +01:00
3bcb6a059f
Mention how to redirect the Jaeger traces to a specific Jaeger instance ( #16531 )
2023-10-23 11:55:36 +00:00
d2eab22de7
Clarify presence router docs. ( #16529 )
2023-10-20 11:40:26 -04:00
166ffc0f23
Fix typo in useful_sql_for_admins.md ( #16477 )
2023-10-12 16:18:32 +01:00
694802eecd
Add documentation on background updates. ( #16420 )
2023-10-06 07:23:20 -04:00
1e67191a79
Add note to 'federation_domain_whitelist' option ( #16416 )
2023-10-03 09:55:29 +01:00
127b940dc0
Clean-up old release notes ( #16418 )
...
Fixes some broken formatting from the reStructuedText to Markdown
conversion and fixes some typos.
2023-10-02 11:05:29 -04:00
5725712d47
Remove Python version from `/_synapse/admin/v1/server_version` ( #16380 )
...
There's no reason to expose the full Python version over what is
frequently a public API.
2023-10-02 09:07:53 -04:00
fb664cf159
Remove warnings from the docs about using message retention. ( #16382 )
...
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.
2023-09-28 07:02:31 -04:00
ec1c709440
Add documentation about the user directory search algorithm ( #16320 )
2023-09-26 13:44:38 +00:00
9fd18e9b06
Add developer documentation concerning gradual schema migrations with column alterations. ( #15691 )
...
Co-authored-by: Eric Eastwood <erice@element.io>
2023-09-25 17:43:09 +00:00
9fabde6ead
Fix-up deactivated notes in docs. ( #16355 )
2023-09-19 08:05:33 -04:00
3d60b07cde
Use string for federation_client_minimum_tls_version documentation examples ( #16353 )
2023-09-19 07:24:47 -04:00
eef2b9e344
Filter locked users in the admin API ( #16328 )
...
Co-authored-by: Hanadi Tamimi <hanadi.tamimi@sdui.de>
2023-09-18 15:37:51 +01:00
dd44ee00b6
Add automatic purge after all users forget a room ( #15488 )
...
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>
2023-09-15 15:37:44 +02:00
39dc5de399
docs: Link to the Alpine Linux community package for Synapse ( #16304 )
2023-09-14 14:13:48 +01:00
5c8870cb28
Fix-up incorrect spellings in docs. ( #16282 )
2023-09-08 09:47:36 -04:00
8940d1b28e
Add `/notifications` endpoint to workers ( #16265 )
2023-09-07 09:26:07 +00:00
fe69e7f617
Handle "registration_enabled" parameter for CAS ( #16262 )
...
Similar to OIDC, CAS providers can now disable registration such
that only existing users are able to login via SSO.
2023-09-06 14:32:24 -04:00
e937e2111a
Add the ability to use `G` (GiB) and `T` (TiB) suffixes in configuration 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>
2023-09-06 14:01:10 +01:00
dfcfa9f0ed
Bump minimum supported Rust version to 1.61.0 ( #16248 )
2023-09-05 13:12:50 +01:00
dcb2778341
Add last_seen_ts to the admin users API ( #16218 )
2023-09-04 18:13:28 +02:00
5c9402b9fd
Add warnings about MSC3861 on certain APIs. ( #16168 )
2023-08-25 07:25:34 -04:00
5856a8ba42
Document `exclude_rooms_fom_sync` configuration option ( #16178 )
2023-08-24 13:57:53 -07:00
aeeca2a62e
Add configuration setting for CAS protocol version ( #15816 )
2023-08-24 16:11:23 -04:00
5427cc20b9
Update URLs to matrix.org blog categories. ( #16008 )
2023-08-24 11:06:06 -04:00
d6ae4041a4
Add `client_secret_path` as alternative for `client_secret` for OIDC config ( #16030 )
2023-08-21 19:32:17 +00:00
54317d34b7
Allow filtering for admins in the list accounts admin API ( #16114 )
2023-08-18 12:26:38 +01:00
4513b36a75
Add link explaining ELK stack to structured_logging.md ( #16091 )
2023-08-16 14:08:35 +01:00
9ff84bccbb
Allow customizing IdP name and icon for SAML and CAS ( #16094 )
2023-08-11 20:15:17 +00:00
dac97642e4
Implements admin API to lock an user (MSC3939) ( #15870 )
2023-08-10 09:10:55 +00:00
9d3713d6d5
Add notes describing Synapse's streams ( #16015 )
...
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
2023-08-07 18:36:04 +01:00
Andrew Morgan