Installation

The guide below was tested on a Debian based Linux distribution.

Requirements

• JDK 1.8
• IRCd

Installing

1. Set up an IRCd and configure it to allow a large number of connections from the telegram-irc host address.

2. Download the latest release from the release page.

3. Unzip the release and build the application:

# ./gradlew build

4. Copy the built application JAR to the installation path of your choosing:

# cp build/libs/telegram-irc-VERSION.jar /usr/share/java/telegram-irc.jar

5. Create a system user that will be utilized when running telegram-irc:

# useradd -r telegramirc

6. Create your Telegram bot and edit the default config using the configuration guide:

# mkdir /etc/telegram-irc
# cp deploy/config.example.yml /etc/telegram-irc/config.yml
# $EDITOR /etc/telegram-irc/config.yml
# chown -R telegramirc:telegramirc /etc/telegram-irc

7. Install the systemd service and ensure the settings are correct for your environment:

# cp deploy/telegram-irc.service /lib/systemd/system
# $EDITOR /lib/systemd/system/telegram-irc.service

8. Optionally enable running on boot, and start the application:

# systemctl enable telegram-irc.service
# systemctl start telegram-irc.service

Some notes:

• Mapped Telegram group channels will be created automatically by the operator bot when a message is received.
• When a user sends a message in a Telegram group, their IRC bot is created and will connect to the server, joining the channel and sending the message automatically.
• By default you will need to send a message in a Telegram group, then /whois the operator bot to see what channels were joined. Then, you can map that channel ID to a channel name of your choosing in the configuration file.
• There is currently no persistence. If telegram-irc is restarted, all telegram user bots will be lost until they send another message on Telegram.