RITlug TeleIRC documentation

Note

This documentation is for v2.x.x releases of TeleIRC. See the v1.3.4 documentation for support with older releases.

RITlug TeleIRC is a Go implementation of a Telegram <=> IRC bridge. TeleIRC works with any IRC channel and Telegram group. It bridges messages and images 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?
  • v2.x.x
  • v1.x.x
  • How to get on this list

User documentation:

• Config file glossary
  • IRC settings
  • Telegram settings
  • Imgur settings
• Frequently asked questions
  • IRC
  • Telegram
  • Imgur
• Quick Start Guide
  • Contents
  • Overview
  • Create a Telegram bot
  • Configure IRC channel
  • Deployment Guide
  • Run container

Developer documentation:

• TeleIRC Code Conventions
  • Naming Conventions
  • Handlers
• Contributing guidelines
  • Table of contents
  • Set up a development environment
  • Open a 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 group and IRC channel on Freenode are available for testing. Our developer community is also found in these channels.

• Telegram: @teleirc

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

Legal

All TeleIRC documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).

Indices and tables

• github.com/RITlug/teleirc

• Index

• Module Index

• Search Page