IRC to Telegram relay
A Telegram<->IRC transport.
Note IRChuu is written in Go and should work on all platforms supported by Go, including Linux, macOS and Windows. Nevertheless, I strongly recommend you using a Linux flavour to run IRChuu, or, as a last resort, macOS. IRChuu is only tested on Linux.
You need to install golang, git and configure your $GOPATH
. Just set $GOPATH
environment variable to a writable directory and add $GOPATH/bin
to your system $PATH
.
After that, install IRChuu~:
$ go install github.com/26000/irchuu/...@latest
Use the same command to upgrade it.
Run IRChuu~ for the first time and it will create a configuration file (you can also use -data
and -config
command-line arguments to specify a custom path):
$ irchuu
IRChuu! v0.6.0 (https://github.com/26000/irchuu)
2017/04/01 15:26:03 New configuration file was populated. Edit /home/26000/.config/irchuu.conf and run `irchuu` again!
Now edit the configuration file with your favourite editor (mine is vim
, but I thought nano
is more popular. Alternatively, you can just use a GUI editor like Kate):
$ nano ~/.config/irchuu.conf
The variables you must set are:
[telegram]
section[irc]
sectionIf you don't know where to get the Telegram token and groupname, refer to the next section.
Others are completely optional. The configuration file is well-documented, but if you have problems, feel free to open an issue on GitHub.
For IRChuu to work, you will need to create a Telegram bot as it works through the Telegram bot API. This is pretty simple:
/newbot
command.@botfather
will send you a token. Insert it into your configuration file./setprivacy
and choose your newly created bot nickname on the inline keyboard. Then choose Disable. This is important! If you forget to do it, messages from Telegram won't be relayed to IRC./setuserpic
and upload a cute picure for your relayirchuu
in console once more)This one is easier. You can just insert your server and channel addresses into your configuration file and choose a nickname. If that nickname is already taken, IRChuu will think of a new one. If you want to own that nickname so that nobody takes it, register it and enter the password in the configuration file. Refer to your server's NickServ focumentation for details.
Just type irchuu
.
Feel free to fork this repo and make PRs. If you encounter a bug, please open an issue — that also helps! I will also be happy if you give IRChuu a star on GitHub.