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

Clarify use of client for development use

Browse Source 
Regular users are not expected to need the provided client
implementation and can instead go straight to their regular Matrix
client and log in to use the sliding-sync proxy.

Fixes: https://github.com/matrix-org/sliding-sync/issues/28
Signed-off-by: Joe Groocock <me@frebib.net>
This commit is contained in:
Joe Groocock 2023-03-27 14:49:21 +01:00
parent 97c9aea176
commit 5735470e73
No known key found for this signature in database
GPG Key ID: E0B16BEACFBB6A86
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -41,7 +41,9 @@ Using a Docker image:
docker run --rm -e "SYNCV3_SERVER=https://matrix-client.matrix.org" -e "SYNCV3_SECRET=$(cat .secret)" -e "SYNCV3_BINDADDR=:8008" -e "SYNCV3_DB=user=$(whoami) dbname=syncv3 sslmode=disable host=host.docker.internal" -p 8008:8008 ghcr.io/matrix-org/sliding-sync:v0.98.0
```
Then visit http://localhost:8008/client/ (with trailing slash) and paste in the `access_token` for any account on `-server`.
Regular users may now log in with their sliding-sync compatible Matrix client. If developing sliding-sync, a simple client is provided (although it is not included in the Docker image).
To use the stub client, visit http://localhost:8008/client/ (with trailing slash) and paste in the `access_token` for any account on `SYNCV3_SERVER`. Note that this will consume to-device messages for the device associated with that access token.
When you hit the Sync button nothing will happen initially, but you should see: