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

Add a landing page.

Browse Source
This commit is contained in:
Doug 2023-02-06 16:58:58 +00:00
parent 2139eda047
commit 45b7c0c4d4
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/Landing.md Normal file
View File

@ -0,0 +1,15 @@
# Sliding Sync Landing Page
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:
```
{
"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!