Skip to content
Snippets Groups Projects
Verified Commit 0f382bca authored by anarcat's avatar anarcat
Browse files

irc: document research on matrix bridges (#42053)

parent 6a541fbe
No related branches found
No related tags found
No related merge requests found
Pipeline #252586 passed with warnings
......@@ -163,11 +163,13 @@ for details.
of the Matrix bridge need to add the channel, you can explicitly ping
@anarcat, @gus and @ahf since they are the ones managing the bridge.
### Matrix.org
For *those* people, you need to use the Element desktop (or web)
client to add the "IRC bridge" integration. This is going to require
an operator in the IRC channel as well.
To an IRC channel with a Matrix room:
To an IRC channel with a Matrix.org room in Element:
1. create the room on Matrix. we currently name rooms with
`#CHANNELNAME:matrix.org`, so for example
......@@ -191,6 +193,32 @@ To an IRC channel with a Matrix room:
8. from IRC, answer the bot's question
### Other bridges
Note that this is specifically for Matrix.org's OFTC bridge, and that,
fun fact, the "integration" above is proprietary software in
Element. A more "normal" way to add a plumbed room is to talk to the
appservice [admin room](https://matrix-org.github.io/matrix-appservice-irc/latest/admin_room.html) using the `!plumb` command:
!plumb !tor-foo:example.com irc.oftc.net #tor-foo
There also seems to be a [place in the configuration file](https://github.com/matrix-org/matrix-appservice-irc/blob/6e52d09732a6ff01899c395b740f1f5a3c20c3df/config.sample.yaml#L296-L304) for such
mappings.
### Changing bridges
It seems possible to change bridges if they are "plumbed". The above
configurations are "plumbed", as opposed to "portaled".
To change the bridge in a "plumbed" room, simply remove the current
bridge and add a new one. In the case of Matrix.org, you need to go in
the integrations and remove the bridge. For the control room, the
command is `!unlink` and then `!plumb` again.
"Portaled" rooms look like `#oftc_#tor-foo:matrix.org` and those
cannot be changed: if the bridge dies, the portal dies with it and
Matrix users need to join another bridge.
## Pager playbook
<!-- TODO: information about common errors from the monitoring system and -->
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment