The teleirc from huqa

teleirc's Introduction

A simple Telegram ↔ IRC gateway.

Changelog

Features:

Supports multiple IRC channel ↔ Telegram group pairs
Telegram messages are always relayed to their respective IRC channel
IRC messages can be configured either to be relayed always, or only when the bot is hilighted via a configurable regexp
Supports Telegram media files, URL to file sent to IRC

Quick start

Make sure you've installed Node.js.

Install the teleirc npm module with npm install -g teleirc (might need sudo)
Generate a default config using teleirc --genconfig
Set up your bot with BotFather
Use the /setprivacy command with BotFather to allow the bot to see all Telegram messages
Edit the default config $EDITOR ~/.teleirc/config.js
Run teleirc
Invite your bot to any Telegram groups you've configured it for
Greet your bot once on each of your Telegram groups 🎉! This is needed to fetch (and store!) an internally used group ID, making communication from IRC to the correct Telegram group possible.

Optional:

For your convenience, there is an included systemd unit file in teleirc.service.
You can change your Telegram Bot's profile picture with the /setuserpic BotFather command. Here's an example icon for you.
You can tell Telegram which commands the teleirc bot supports by using the /setcommands BotFather command. You may copy-paste the contents of commands.txt to show all supported commands to Telegram clients.

Developer install (from git)

git clone https://github.com/FruitieX/teleirc
cd teleirc
npm install

Then follow the instructions under Setup, with the exception of step 1. Also, instead of using the teleirc command, use node teleirc.js inside the repo.

Use the develop branch for developing, and please also send any pull requests to this branch. The master branch contains the latest stable version which is also released on npm.

Make sure that the unit tests pass before submitting your pull request, using npm test.

Recommend Projects