MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-05-20 20:03:45 +02:00
Code Issues Releases Wiki Activity

Updated Bridges (markdown)

Jason Volk 2023-02-16 11:11:47 -08:00
parent 9322d79c62
commit 494ad19bb3
1 changed files with 25 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
Bridges.md

@ -20,10 +20,31 @@
bridge set /path/to/registration.json
```
> If the bridge has already been registered before then the prior configuration will be overwritten. Use `bridge add` to error instead of overwriting.
> The console command `bridge` will list all bridges by ID. `bridge <id>` will confirm the configuration for the bridge.
> If the bridge has already been registered before then the prior configuration will be overwritten.
> Registrations and/or updates will take effect immediately without restarting the server or reloading `m_bridge`
> `bridge del <id>` will redact the registration and disconnect the bridge.
## Commands
- `bridge`: List all of the registered bridges by their `id`.
- `bridge <id>`: Display the registration of a specific bridge by `id`.
- `bridge add <path>`: Register a new bridge based on the registration file. It is an error if a bridge with the same `id` is already registered. Upon success, the server will connect to the bridge and send events.
- `bridge set <path>`: Create or update the registration of a bridge based on a registration file. The prior registration will be overwritten; the server will reconnect to the bridge based on the new registration. When there is no change this command is a no-op.
- `bridge del <id>`: Redact the registration of a bridge by `id`. The server will disconnect from the bridge.
## Configuration
> Configuration items can be set using the `conf set <item> <value>` command or as environment variables by replacing the dots with underscores.
- `ircd.m.bridge.enable`: Set to false to disable the bridge subsystem on startup.
- `ircd.m.bridge.backoff`: The timeout in seconds for the server to retry its connection to a bridge.
- `ircd.m.bridge.txn.timeout`: The timeout in seconds for the server to wait for the bridge to process each pushed transaction.
- `ircd.m.bridge.txn.bufsize`: The size of the transaction buffer. When the server has to synchronize a large number of events to the bridge it will limit each transaction to this size.