From 00d91200a75940ab3484c88b12d8dab70ca5e9d2 Mon Sep 17 00:00:00 2001 From: Jason Volk Date: Mon, 13 Feb 2023 23:27:18 -0800 Subject: [PATCH] Updated Bridges (markdown) --- Bridges.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/Bridges.md b/Bridges.md index e1a3a6b..f33c223 100644 --- a/Bridges.md +++ b/Bridges.md @@ -1,6 +1,8 @@ ## 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. +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. 2. Convert the `registration.yaml` to `registration.json` using a yaml2json converter such as `apt-get install reserialize` or a website. @@ -8,12 +10,14 @@ 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: +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 ``` -- If the bridge has already been registered then configuration will be updated. - -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 +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