2021-05-13 16:25:42 +01:00
|
|
|
# sync-v3
|
2021-05-14 16:49:33 +01:00
|
|
|
|
|
|
|
|
Run an experimental sync v3 server using an existing Matrix account. This is possible because, for the most part,
|
|
|
|
|
v3 sync is a strict subset of v2 sync.
|
|
|
|
|
|
2021-08-05 17:28:38 +01:00
|
|
|
**UNDER ACTIVE DEVELOPMENT, BREAKING CHANGES ARE FREQUENT.**
|
|
|
|
|
|
2021-05-14 16:49:33 +01:00
|
|
|
## Usage
|
|
|
|
|
|
2021-07-21 10:30:04 +01:00
|
|
|
```bash
|
2021-05-14 16:49:33 +01:00
|
|
|
$ createdb syncv3
|
|
|
|
|
$ go build ./cmd/syncv3
|
|
|
|
|
$ ./syncv3 -server "https://matrix-client.matrix.org" -db "user=$(whoami) dbname=syncv3 sslmode=disable"
|
|
|
|
|
```
|
2021-07-21 10:30:04 +01:00
|
|
|
|
2021-09-30 17:02:53 +01:00
|
|
|
Then visit http://localhost:8008/client/ (with trailing slash) and paste in the `access_token` for any account on `-server`.
|
2021-07-21 10:30:04 +01:00
|
|
|
|
2021-09-30 17:28:36 +01:00
|
|
|
When you hit the Sync button nothing will happen initially, but you should see:
|
|
|
|
|
```
|
|
|
|
|
INF Poller: v2 poll loop started ip=::1 since= user_id=@kegan:matrix.org
|
|
|
|
|
```
|
|
|
|
|
Wait for the first initial v2 sync to be processed (this can take minutes!) and then v3 APIs will be responsive.
|
|
|
|
|
|
2021-09-30 17:02:53 +01:00
|
|
|
## API
|
2021-07-21 10:30:04 +01:00
|
|
|
|
2021-09-30 17:02:53 +01:00
|
|
|
API is under active development and is not stable.
|
