@@ -119,11 +119,30 @@ used with the `--type` flag.
119119[ mautrix-linkedin ] : https://github.com/mautrix/linkedin
120120[ heisenbridge ] : https://github.com/hifi/heisenbridge
121121
122- ### 3rd party bridges
123- 3 . Run ` bbctl register <name> ` to generate an appservice registration file.
122+ ### 3rd party bridgev2-based bridges
123+ If you have a 3rd party bridge that's built on top of mautrix-go's bridgev2
124+ framework, you can have bbctl generate a mostly-complete config file:
125+
126+ 3 . Run ` bbctl config --type bridgev2 <name> ` to generate a bridgev2 config with
127+ everything except the ` network ` section.
124128 * ` <name> ` is a short name for the bridge (a-z, 0-9, -). The name should
125129 start with ` sh- ` . The bridge user ID namespace will be ` @<name>_.+:beeper.local `
126130 and the bridge bot will be ` @<name>bot:beeper.local ` .
131+ 4 . Add the ` network ` section containing the bridge-specific configuration if
132+ necessary, then run the bridge normally.
133+
134+ All bridgev2 bridges support appservice websockets, so using ` bbctl proxy ` is
135+ not necessary.
136+
137+ #### 3rd party custom bridges
138+ For any 3rd party bridges that don't use bridgev2, you'll only get a registration
139+ file from bbctl and will have to configure the bridge yourself. Also, since such
140+ 3rd party bridges are unlikely to support Beeper's appservice websocket protocol,
141+ you probably have to use ` bbctl proxy ` to connect to the websocket and turn
142+ incoming data into HTTP requests for the bridge.
143+
144+ 3 . Run ` bbctl register <name> ` to generate an appservice registration file.
145+ * ` <name> ` is the same as in the above section.
1271464 . Now you can configure and run the bridge by following the bridge's own
128147 documentation.
1291485 . Modify the registration file to point at where the bridge will listen locally
0 commit comments