oss/conduit
oss/conduit
1
0
Fork 0
mirror of https://gitlab.com/famedly/conduit.git synced 2025-06-27 16:35:59 +00:00
Code Wiki Activity

docs: update info on simplified sliding sync

Browse source
This commit is contained in:
Matthias Ahouansou 2025-05-09 12:34:40 +01:00
parent 88c95d36a8
commit 52c64cb62d
No known key found for this signature in database
2 changed files with 2 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/delegation.md
View file

@ -14,8 +14,6 @@ This is only recommended if Conduit is on the same physical server as the server
as servers don't always seem to cache the response, leading to slower response times otherwise, but it should also work if you as servers don't always seem to cache the response, leading to slower response times otherwise, but it should also work if you
are connected to the server running Conduit using something like a VPN. are connected to the server running Conduit using something like a VPN.
> **Note**: this will automatically allow you to use [sliding sync][0] without any extra configuration
To configure it, use the following options in the `global.well_known` table: To configure it, use the following options in the `global.well_known` table:
| Field | Type | Description | Default | | Field | Type | Description | Default |
| --- | --- | --- | --- | | --- | --- | --- | --- |
@ -63,7 +61,3 @@ Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization
``` ```
If you also want to be able to use [sliding sync][0], look [here](faq.md#how-do-i-setup-sliding-sync).
[0]: https://matrix.org/blog/2023/09/matrix-2-0/#sliding-sync

18
docs/faq.md
View file

@ -13,23 +13,9 @@ You can simply stop Conduit, make a copy or file system snapshot of the database
> **Note**: When using a file system snapshot, it is not required that you stop the server, but it is still recommended as it is the safest option and should ensure your database is not left in an inconsistent state. > **Note**: When using a file system snapshot, it is not required that you stop the server, but it is still recommended as it is the safest option and should ensure your database is not left in an inconsistent state.
## How do I setup sliding sync? ## How do I setup simplified sliding sync?
If you use the [automatic method for delegation](delegation.md#automatic-recommended) or just proxy `.well-known/matrix/client` to Conduit, sliding sync should work with no extra configuration. You don't need to! If your Conduit instance is reachable, simplified sliding sync should work right out of the box, no delegation required
If you don't, continue below.
You need to add a `org.matrix.msc3575.proxy` field to your `.well-known/matrix/client` response which contains a url which Conduit is accessible behind.
Here is an example:
```json
{
~ "m.homeserver": {
~ "base_url": "https://matrix.example.org"
~ },
"org.matrix.msc3575.proxy": {
"url": "https://matrix.example.org"
}
}
```
## Can I migrate from Synapse to Conduit? ## Can I migrate from Synapse to Conduit?