-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
7 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,36 +8,10 @@ This describes which proxy versions implement which version of the API drafted | |
| in MSC3575. See https://github.com/matrix-org/sliding-sync/releases for the | ||
| changes in the proxy itself. | ||
|
|
||
| - Version 0.1.x: [2022/04/01](https://github.com/matrix-org/matrix-spec-proposals/blob/615e8f5a7bfe4da813bc2db661ed0bd00bccac20/proposals/3575-sync.md) | ||
| - First release | ||
| - Version 0.2.x: [2022/06/09](https://github.com/matrix-org/matrix-spec-proposals/blob/3b2b3d547b41e4aeebbde2ad6e89606dd684a86c/proposals/3575-sync.md) | ||
| - Reworked where lists and ops are situated in the response JSON. Added new filters like `room_name_like`. Added `slow_get_all_rooms`. Standardised on env vars for configuring the proxy. Persist access tokens, encrypted with `SYNCV3_SECRET`. | ||
| - Version 0.3.x: [2022/08/05](https://github.com/matrix-org/matrix-spec-proposals/blob/61decae837b5448b073fc5c718172f9b4d1e5e18/proposals/3575-sync.md) | ||
| - Spaces support, `txn_id` support. | ||
| - Version 0.4.x [2022/08/23](https://github.com/matrix-org/matrix-spec-proposals/blob/59c83a857b4cf3cf6aca593c34efb44709b10d17/proposals/3575-sync.md) | ||
| - Support for `tags` and `not_tags`. | ||
| - Version 0.98.x [2022/12/16](https://github.com/matrix-org/matrix-spec-proposals/blob/2538552705487ecef34abf1dd1afb61e25a06f28/proposals/3575-sync.md) | ||
| - Preparing for major v1.x release: add Prometheus metrics, PPROF, etc. | ||
| - Support `typing` and `receipts` extensions. | ||
| - Support for `num_live`, `joined_count` and `invited_count`. | ||
| - Support for `by_notification_level` and `include_old_rooms`. | ||
| - Support for `$ME` and `$LAZY`. | ||
| - Support for `errcode` when sessions expire. | ||
| - Version 0.99.1 [2023/01/20](https://github.com/matrix-org/matrix-spec-proposals/blob/b4b4e7ff306920d2c862c6ff4d245110f6fa5bc7/proposals/3575-sync.md) | ||
| - Preparing for major v1.x release: lists-as-keys support. | ||
| - Version 0.99.2 [2023/03/31](https://github.com/matrix-org/matrix-spec-proposals/blob/eab643cb3ca63b03537a260fa343e1fb2d1ee284/proposals/3575-sync.md) | ||
| - Experimental support for `bump_event_types` when ordering rooms by recency. | ||
| - Support for opting in to extensions on a per-list and per-room basis. | ||
| - Version 0.99.3 [2023/05/23](https://github.com/matrix-org/matrix-spec-proposals/blob/4103ee768a4a3e1decee80c2987f50f4c6b3d539/proposals/3575-sync.md) | ||
| - Support for per-list `bump_event_types`. | ||
| - Support for [`conn_id`](https://github.com/matrix-org/matrix-spec-proposals/blob/4103ee768a4a3e1decee80c2987f50f4c6b3d539/proposals/3575-sync.md#concurrent-connections) for distinguishing multiple concurrent connections. | ||
| - Version 0.99.4 [2023/07/12](https://github.com/matrix-org/matrix-spec-proposals/blob/4103ee768a4a3e1decee80c2987f50f4c6b3d539/proposals/3575-sync.md) | ||
| - Support for `SYNCV3_MAX_DB_CONN`, and reduce the amount of concurrent connections required during normal operation. | ||
| - Add more metrics and logs. Reduce log spam. | ||
| - Improve performance when handling changed device lists. | ||
| - Responses will consume from the live buffer even when clients change their request parameters to more speedily send new events down. | ||
| - Bugfix: return `invited_count` correctly when it transitions to 0. | ||
| - Bugfix: fix a data corruption bug when 2 users join a federated room where the first user was invited to said room. | ||
| As of v0.99.7, the proxy implements [this version of the MSC](https://github.com/matrix-org/matrix-spec-proposals/blob/71fb1a2e3780ae07e03850d96ce3bad59305986e/proposals/3575-sync.md) with the following exceptions: | ||
| - the `limited` flag is not set in responses. | ||
| - Delta tokens are unsupported. | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
|
|
@@ -62,7 +36,9 @@ SYNCV3_TLS_CERT Default: unset. Path to a certificate file to serve to HTTPS c | |
| SYNCV3_TLS_KEY Default: unset. Path to a key file for the certificate. Must be provided along with the certificate file. | ||
| SYNCV3_PPROF Default: unset. The bind addr for pprof debugging e.g ':6060'. If not set, does not listen. | ||
| SYNCV3_PROM Default: unset. The bind addr for Prometheus metrics, which will be accessible at /metrics at this address. | ||
| SYNCV3_JAEGER_URL Default: unset. The Jaeger URL to send spans to e.g http://localhost:14268/api/traces - if unset does not send OTLP traces. | ||
| SYNCV3_OTLP_URL Default: unset. The OTLP HTTP URL to send spans to e.g https://localhost:4318 - if unset does not send OTLP traces. | ||
| SYNCV3_OTLP_USERNAME Default: unset. The OTLP username for Basic auth. If unset, does not send an Authorization header. | ||
| SYNCV3_OTLP_PASSWORD Default: unset. The OTLP password for Basic auth. If unset, does not send an Authorization header. | ||
| SYNCV3_SENTRY_DSN Default: unset. The Sentry DSN to report events to e.g https://[email protected]/123 - if unset does not send sentry events. | ||
| SYNCV3_LOG_LEVEL Default: info. The level of verbosity for messages logged. Available values are trace, debug, info, warn, error and fatal | ||
| SYNCV3_MAX_DB_CONN Default: unset. Max database connections to use when communicating with postgres. Unset or 0 means no limit. | ||
|
|
||