Skip to content

6697/teleirc

 
 

Repository files navigation

Logo

A simple Telegram ↔ IRC gateway.

Build Status npm module dependencies devDependencies

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.

  1. Install the teleirc npm module with npm install -g teleirc (might need sudo)
  2. Generate a default config using teleirc --genconfig
  3. Set up your bot with BotFather
  4. Use the /setprivacy command with BotFather to allow your bot to see all messages in your group (NOTE on usage: bot name is preceded by @ sign and 'Disable' is case-sensitive)
  5. Edit the default config $EDITOR ~/.teleirc/config.js
  6. Run teleirc
  7. Invite your bot to any Telegram groups you've configured it for
  8. 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: 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.

Contributing

See CONTRIBUTING.md for developer info

Docker install

See the README for Docker

About

A simple Telegram ↔ IRC gateway.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%