danio
/
nixos-matrix-modules
mirror of https://github.com/dali99/nixos-matrix-modules.git
1
1
Fork 0
Code Issues Releases Activity

Add documentation for new sliding-sync setup and upgrade info

This commit is contained in:
Daniel Lovbrotte Olsen 2024-09-27 06:21:28 +02:00
parent f8843835e2
commit ff787d410c
2 changed files with 5 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
MIGRATIONS.MD
View File

@ -2,6 +2,11 @@
This is a best effort document descibing neccecary changes you might have to do when updating 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 ## 0.5.0
* The module has been renamed from `synapse` to `default` * The module has been renamed from `synapse` to `default`

16
README.MD
View File

@ -38,19 +38,3 @@ With matrix.YOURDOMAIN pointing at the server:
``` ```
is ~enough to get a functional matrix-server running with some workers 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`