mirror of
				https://github.com/matrix-org/synapse.git
				synced 2025-10-31 12:18:24 +00:00 
			
		
		
		
	Tweak changelog and upgrade notes
This commit is contained in:
		
							parent
							
								
									ea6fcda98d
								
							
						
					
					
						commit
						5cae9158e6
					
				| @ -1,6 +1,8 @@ | |||||||
| Synapse 1.84.0 (2023-05-23) | Synapse 1.84.0 (2023-05-23) | ||||||
| =========================== | =========================== | ||||||
| 
 | 
 | ||||||
|  | The `worker_replication_*` configuration settings have been deprecated in favour of configuring the main process consistently with other instances in the `instance_map`. The deprecated settings will be removed in Synapse v1.88.0, but changing your configuration in advance is recommended. See the [upgrade notes](https://github.com/matrix-org/synapse/blob/release-v1.84/docs/upgrade.md#upgrading-to-v1840) for more information. | ||||||
|  | 
 | ||||||
| Bugfixes | Bugfixes | ||||||
| -------- | -------- | ||||||
| 
 | 
 | ||||||
| @ -32,6 +34,12 @@ Bugfixes | |||||||
| - Require at least poetry-core v1.1.0. ([\#15566](https://github.com/matrix-org/synapse/issues/15566), [\#15571](https://github.com/matrix-org/synapse/issues/15571)) | - Require at least poetry-core v1.1.0. ([\#15566](https://github.com/matrix-org/synapse/issues/15566), [\#15571](https://github.com/matrix-org/synapse/issues/15571)) | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|  | Deprecations and Removals | ||||||
|  | ------------------------- | ||||||
|  | 
 | ||||||
|  | - Remove need for `worker_replication_*` based settings in worker configuration yaml by placing this data directly on the `instance_map` instead. ([\#15491](https://github.com/matrix-org/synapse/issues/15491)) | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
| Updates to the Docker image | Updates to the Docker image | ||||||
| --------------------------- | --------------------------- | ||||||
| 
 | 
 | ||||||
| @ -51,7 +59,6 @@ Internal Changes | |||||||
| 
 | 
 | ||||||
| - Use oEmbed to generate URL previews for YouTube Shorts. ([\#15025](https://github.com/matrix-org/synapse/issues/15025)) | - Use oEmbed to generate URL previews for YouTube Shorts. ([\#15025](https://github.com/matrix-org/synapse/issues/15025)) | ||||||
| - Create new `Client` for use with HTTP Replication between workers. Contributed by Jason Little. ([\#15470](https://github.com/matrix-org/synapse/issues/15470)) | - Create new `Client` for use with HTTP Replication between workers. Contributed by Jason Little. ([\#15470](https://github.com/matrix-org/synapse/issues/15470)) | ||||||
| - Remove need for `worker_replication_*` based settings in worker configuration yaml by placing this data directly on the `instance_map` instead. ([\#15491](https://github.com/matrix-org/synapse/issues/15491)) |  | ||||||
| - Bump pyicu from 2.10.2 to 2.11. ([\#15509](https://github.com/matrix-org/synapse/issues/15509)) | - Bump pyicu from 2.10.2 to 2.11. ([\#15509](https://github.com/matrix-org/synapse/issues/15509)) | ||||||
| - Remove references to supporting per-user flag for [MSC2654](https://github.com/matrix-org/matrix-spec-proposals/pull/2654). ([\#15522](https://github.com/matrix-org/synapse/issues/15522)) | - Remove references to supporting per-user flag for [MSC2654](https://github.com/matrix-org/matrix-spec-proposals/pull/2654). ([\#15522](https://github.com/matrix-org/synapse/issues/15522)) | ||||||
| - Don't use a trusted key server when running the demo scripts. ([\#15527](https://github.com/matrix-org/synapse/issues/15527)) | - Don't use a trusted key server when running the demo scripts. ([\#15527](https://github.com/matrix-org/synapse/issues/15527)) | ||||||
|  | |||||||
| @ -93,14 +93,21 @@ process, for example: | |||||||
| ## Deprecation of `worker_replication_*` configuration settings | ## Deprecation of `worker_replication_*` configuration settings | ||||||
| 
 | 
 | ||||||
| When using workers, | When using workers, | ||||||
|  | 
 | ||||||
| * `worker_replication_host` | * `worker_replication_host` | ||||||
| * `worker_replication_http_port` | * `worker_replication_http_port` | ||||||
| * `worker_replication_http_tls` | * `worker_replication_http_tls` | ||||||
|   |   | ||||||
| can now be removed from individual worker YAML configuration ***if*** you add the main process to the `instance_map` in the shared YAML configuration, | should now be removed from individual worker YAML configurations and the main process should instead be added to the `instance_map` | ||||||
| using the name `main`. | in the shared YAML configuration, using the name `main`. | ||||||
|  | 
 | ||||||
|  | The old `worker_replication_*` settings are now considered deprecated and are expected to be removed in Synapse v1.88.0. | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | ### Example change | ||||||
|  | 
 | ||||||
|  | #### Before: | ||||||
| 
 | 
 | ||||||
| ### Before: |  | ||||||
| Shared YAML | Shared YAML | ||||||
| ```yaml | ```yaml | ||||||
| instance_map: | instance_map: | ||||||
| @ -109,6 +116,7 @@ instance_map: | |||||||
|     port: 5678 |     port: 5678 | ||||||
|     tls: false |     tls: false | ||||||
| ``` | ``` | ||||||
|  | 
 | ||||||
| Worker YAML | Worker YAML | ||||||
| ```yaml | ```yaml | ||||||
| worker_app: synapse.app.generic_worker | worker_app: synapse.app.generic_worker | ||||||
| @ -130,7 +138,10 @@ worker_listeners: | |||||||
| 
 | 
 | ||||||
| worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml | worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml | ||||||
| ``` | ``` | ||||||
| ### After: | 
 | ||||||
|  | 
 | ||||||
|  | #### After: | ||||||
|  | 
 | ||||||
| Shared YAML | Shared YAML | ||||||
| ```yaml | ```yaml | ||||||
| instance_map: | instance_map: | ||||||
| @ -143,6 +154,7 @@ instance_map: | |||||||
|     port: 5678 |     port: 5678 | ||||||
|     tls: false |     tls: false | ||||||
| ``` | ``` | ||||||
|  | 
 | ||||||
| Worker YAML | Worker YAML | ||||||
| ```yaml | ```yaml | ||||||
| worker_app: synapse.app.generic_worker | worker_app: synapse.app.generic_worker | ||||||
| @ -165,7 +177,6 @@ Notes: | |||||||
| * `tls` is optional but mirrors the functionality of `worker_replication_http_tls` | * `tls` is optional but mirrors the functionality of `worker_replication_http_tls` | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| 
 |  | ||||||
| # Upgrading to v1.81.0 | # Upgrading to v1.81.0 | ||||||
| 
 | 
 | ||||||
| ## Application service path & authentication deprecations | ## Application service path & authentication deprecations | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user