RITlug TeleIRC documentation

RITlug TeleIRC is a NodeJS implementation of a Telegram <=> IRC bridge. TeleIRC works with any IRC channel and Telegram group. It bridges messages between a Telegram group and an IRC channel.

This bot was originally written for RITlug. Today, it is used by various communities.

About TeleIRC:

• Who uses TeleIRC?
  • How to get on this list

User documentation:

• Quick install
  • Create a Telegram bot
  • Configure IRC channel
  • Configure and run TeleIRC
• How to deploy TeleIRC
  • systemd
  • pm2
  • Arch Linux AUR
  • Docker
• Config file glossary
  • IRC settings
  • Telegram settings
  • Imgur settings
  • Miscellaneous settings
• Frequently asked questions
  • IRC
  • Telegram

Developer documentation:

• Contributing guidelines
  • Table of contents
  • Set up a development environment
  • Open a new pull request
  • Maintainer response time
• Message State Diagram
• Go testing: Best practices
  • What is unit testing?
  • Interfaces
  • Generating mocks from interfaces with libraries

Live demo

A public Telegram supergroup and IRC channel (on Freenode) are available for testing. Our developer community is found in these channels.

• Telegram: @teleirc
• IRC: #rit-lug-teleirc (chat.freenode.net)

Indices and tables

• github.com/RITlug/teleirc
• Index
• Module Index
• Search Page