Skip to content

Instantly share code, notes, and snippets.

@magical

magical/matrix-irc.md

Created March 1, 2019 00:24
Show Gist options
  • Star 3 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save magical/48de9b0fa61bcee914885ec3362b3429 to your computer and use it in GitHub Desktop.
Save magical/48de9b0fa61bcee914885ec3362b3429 to your computer and use it in GitHub Desktop.
Download ZIP
HOWTO connect to IRC with matrix (draft)
Raw
matrix-irc.md

HOWTO connect to IRC with matrix

This guide explains how to connect to freenode channels via matrix, using riot.im.

  1. matrix.org runs a public freenode bridge.

  2. channels follow the pattern #freenode_#channel:matrix.org, so if you wanted to join #python on freenode, you'd type '#freenode_#python:matrix.org' into the join channel box in riot.im.

  3. nicknames follow the pattern @freenode_nick:matrix.org, so if you wanted to talk to NickServ, you'd send a message to '@freenode_NickServ:matrix.org'.

  4. you can't just join any channel you feel like: many freenode channels require users to be registered, to cut down on spam. just registering for matrix isn't enough; you have to register with freenode too

  5. by default, your freenode username is your matrix username with '[m]' added, so if your username is cyberbob, your irc nick will be cyberbob[m].

  6. you can change a bunch of options by talking to @appservice-irc:matrix.org - including changing your nick and set your password

from the top:

  1. if you haven't done so yet, create a matrix account. you can do so here: https://riot.im/app/#/register.

matrix is decentralized, so you can create an account on any matrix server. the server your account is on is called your homeserver. note that, by default, your account is created on matrix.org, the flagship homeserver; however, it is under increased amount of load. please consider creating an account on another homeserver instead. there is an unofficial list of homeservers here: https://www.hello-matrix.net/public_servers.php.

  1. join a channel. click the plus button, select join channel, and type in #freenode_#osu-osl:matrix.org after you do this, you'll get an invite from @freenode_freenode-connect:matrix.org. go ahead and accept it. this might tell you information about your freenode connection or something, i guess.

  2. leave the channel. you might need to change your nickname in the next step, and you can't do that when you're in a +R channel like #osu-lug

  3. register your nick. if you have an existing freenode account, you can use that; otherwise, you'll need to register a new account

4a. existing account. message '!nick yournick' to @appservice-irc:matrix.org. this will change your freenode nick. you should get a message from nickserv about the nick already being registered. go ahead and send 'identify <password>' to nickserv to log in like normal.

4b. new account. (optionally) message !nick yournick to @appservice-irc:matrix.org to change your nick if you don't want the default one. if you get a message from nickserv about needing to identify yourself, then that nickname is taken and you'll have to choose another one. once you've found an unused nickname, message @freenode_NickServ:matrix.org and tell it to register <password> <email>. you can find out more about registration in the freenode docs: https://freenode.net/kb/answer/registration.

  1. set your password. go back to @appservice-irc:matrix.org and tell it !setpass <password>. this will let it log in the next time you have to reconnect to freenode. matrix will keep you connected

  2. join the channel again. #freenode_#osu-osl:matrix.org

  3. done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment