From ab1d2a7ffa510750b1e83e211dc6804bfd75fc2b Mon Sep 17 00:00:00 2001 From: Jason Volk Date: Mon, 13 Feb 2023 23:37:09 -0800 Subject: [PATCH] Updated Bridges (markdown) --- Bridges.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/Bridges.md b/Bridges.md index f33c223..ba530e9 100644 --- a/Bridges.md +++ b/Bridges.md @@ -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 ` 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. - \ No newline at end of file + > The console command `bridge` will list all bridges by ID. `bridge ` 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. \ No newline at end of file