go/sliding-sync
go/sliding-sync
1
0
Fork 0
mirror of https://github.com/matrix-org/sliding-sync.git synced 2025-03-10 13:37:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #457 from matrix-org/richvdh-patch-1

Browse Source 
landing.md: clarifications
This commit is contained in:
Kegan Dougal 2024-08-21 09:29:15 +01:00 committed by GitHub
commit 3804a90bf8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/Landing.md
View File

@ -2,20 +2,22 @@
Welcome intrepid Matrix explorer. You've landed on this page because you're trying to use a next generation client that requires your homeserver supports a new and experimental feature called sliding sync which enables lightning fast loading of your messages. In order to continue with this client, you'll need to ask your server admin to do the following:
- Configure Postgres and install a sliding sync proxy as described in the [docs](https://github.com/matrix-org/sliding-sync).
- Advertise the proxy by configuring an [`org.matrix.msc3575.proxy`](https://github.com/matrix-org/matrix-spec-proposals/blob/kegan/sync-v3/proposals/3575-sync.md#unstable-prefix) property in the server's `/.well-known/matrix/client` config:
```json
{
"org.matrix.msc3575.proxy": {
"url": "https://slidingsync.proxy.url.here"
}
}
```
You can do this by adding the following to your homeserver.yaml:
```yaml
extra_well_known_client_content:
"org.matrix.msc3575.proxy":
"url": "https://slidingsync.proxy.url.here"
```
1. Configure Postgres and install a sliding sync proxy as described in the [docs](https://github.com/matrix-org/sliding-sync).
2. Advertise the proxy by configuring an [`org.matrix.msc3575.proxy`](https://github.com/matrix-org/matrix-spec-proposals/blob/kegan/sync-v3/proposals/3575-sync.md#unstable-prefix) property in the server's `/.well-known/matrix/client` file (see [Synapse docs](https://element-hq.github.io/synapse/latest/setup/installation.html#client-well-known-uri)):
```json
{
"org.matrix.msc3575.proxy": {
"url": "https://slidingsync.proxy.url.here"
}
}
```
If you are using Synapse's built-in support for `/.well-known/matrix/client` (i.e., you have configured your reverse proxy to forward `https://<server_name>/.well-known/matrix/client` requests to Synapse), you can do this by adding the following to your `homeserver.yaml`:
```yaml
extra_well_known_client_content:
"org.matrix.msc3575.proxy":
"url": "https://slidingsync.proxy.url.here"
```
Once these steps are complete you will be able to continue on your journey of exploring the very latest that Matrix has to offer!