Skip to content

Commit

Permalink
Add documentation for new sliding-sync setup and upgrade info
Browse files Browse the repository at this point in the history
  • Loading branch information
dali99 committed Sep 27, 2024
1 parent f884383 commit ff787d4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 16 deletions.
5 changes: 5 additions & 0 deletions MIGRATIONS.MD
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

This is a best effort document descibing neccecary changes you might have to do when updating

## 0.6.1

enableSlidingSync, and setting matrix-synapse.sliding-sync.environmentFile (or any other sliding-sync setting)
is no longer needed for a sliding-sync setup. Upgrading will force relogins for all users.

## 0.5.0

* The module has been renamed from `synapse` to `default`
Expand Down
16 changes: 0 additions & 16 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,3 @@ With matrix.YOURDOMAIN pointing at the server:
```

is ~enough to get a functional matrix-server running with some workers

## Sliding Sync (Element X)

Just add the following to your config and point `slidingsync.YOURDOMAIN` at the server

```
services.matrix-synapse-next = {
enableSlidingSync = true;
};
services.matrix-synapse.sliding-sync.environmentFile = "/some/file/containing/SYNCV3_SECRET=<some secret>";
```

If using [well-known delagation](https://matrix-org.github.io/synapse/v1.37/delegate.html) make sure `YOURDOMAIN/.well-known/matrix/client` matches
what's in `matrix.YOURDOMAIN/.well-known/matrix/client`

0 comments on commit ff787d4

Please sign in to comment.