0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-05-20 20:03:45 +02:00

Updated Bridges (markdown)

Jason Volk 2023-02-13 23:37:09 -08:00
parent 00d91200a7
commit ab1d2a7ffa

@ -1,23 +1,25 @@
## Bridge Registration
1. [Follow instructions for setting up your bridge](https://docs.mau.fi/bridges/python/setup.html). This should produce a `registration.yaml` file.
- :exclamation: The bridge `id` and the `sender_localpart` have to match at this time.
- The bridge user and room will be created based on this `id` automatically (e.g. `!id:localhost`). It is also okay if these already exist.
> :exclamation: The bridge `id` and the `sender_localpart` have to match at this time.
> The bridge user and room will be created based on this `id` automatically (e.g. `!id:localhost`). It is also okay if these already exist.
2. Convert the `registration.yaml` to `registration.json` using a yaml2json converter such as `apt-get install reserialize` or a website.
```
reserialize yaml2json registration.yaml > registration.json
```
```
reserialize yaml2json registration.yaml > registration.json
```
3. Open the [console](https://github.com/matrix-construct/construct/wiki/Useful-console-command-examples) to enter the following command:
- If the bridge has already been registered before then the prior configuration will be overwritten.
- The console command `bridge` will list all bridges by ID. `bridge <id>` will confirm the configuration for the bridge.
```
bridge set /path/to/registration.json
```
```
> bridge set /path/to/registration.json
```
> If the bridge has already been registered before then the prior configuration will be overwritten.
4. The bridge module may have to be reloaded `mod reload m_bridge` in the console to take effect.
> The console command `bridge` will list all bridges by ID. `bridge <id>` will confirm the configuration for the bridge.
4. The bridge module may have to be reloaded `mod reload m_bridge` in the console to take effect.