Config file glossary
This page is a glossary of different settings in the env.example configuration file.
All values shown are the default settings.
This glossary is intended for advanced users.
IRC settings
Host connection settings
IRC_HOST_IP=""Specify IP address to use for IRC connection. Useful for hosts with multiple IP addresses.
Server connection settings
IRC_SERVER=irc.libera.chatIRC server to connect to
Caution
Required setting (cannot be empty)
IRC_SERVER_PASSWORD=""IRC server password
IRC_PORT=6697IRC server port
Encryption options
IRC_USE_SSL=falseConnect to the IRC server with SSL when set to true
IRC_CERT_ALLOW_EXPIRED=trueAllow connecting to IRC server with an expired TLS/SSL certificate
IRC_CERT_ALLOW_SELFSIGNED=trueAllows TeleIRC to accept TLS/SSL certificates from non-trusted/unknown Certificate Authorities (CA)
Channel settings
IRC_CHANNEL="#channel"IRC channel for bot to join
Caution
Required setting (cannot be empty)
IRC_CHANNEL_KEY=""IRC channel key, for password-protected channels
IRC_BLACKLIST=""Comma-separated list of IRC nicks to ignore
Bot settings
IRC_BOT_NAME=teleircIRC nickname for bot. Most IRC clients and bridges show this nickname.
Caution
Required setting (cannot be empty)
IRC_BOT_REALNAME="Powered by TeleIRC <github.com/RITlug/teleirc>"IRC
REALNAMEfor bot. Often visible in IRC/whoisreports, but most clients do not show this information by default.IRC_BOT_IDENT=teleircIdentification metadata for bot connection. This is rarely used or shown in most IRC clients and bridges, so only change this if you know what you are doing. Often visible in IRC
/whoisreports, but most clients do not show this information by default.
NickServ options
IRC_NICKSERV_SERVICE=NickServIRC service used for authentication.
IRC_NICKSERV_USER=""IRC NickServ username.
IRC_NICKSERV_PASS=""IRC NickServ password.
Message settings
TELEGRAM_MESSAGE_PREFIX="<"Text displayed before Telegram name in IRC
TELEGRAM_MESSAGE_SUFFIX=">"Text displayed after Telegram name in IRC
IRC_SEND_STICKER_EMOJI=trueSend emojis associated with a sticker to IRC (when a Telegram user sends a sticker)
IRC_SEND_DOCUMENT=trueSend documents and files from Telegram to IRC (why is this true by default?)
IRC_EDITED_PREFIX="[EDIT] "Prefix to prepend to messages when a user edits a Telegram message and it is resent to IRC
IRC_MAX_MESSAGE_LENGTH=400Maximum length of the message that can be sent to IRC. Longer messages are split into multiple messages.
IRC_SHOW_ZWSP=truePrevents users with the same Telegram and IRC username from pinging themselves across platforms.
IRC_SHOW_JOIN_MESSAGE=trueShow in IRC when someone joins the Telegram chat.
IRC_SHOW_LEAVE_MESSAGE=trueShow in IRC when someone leaves the Telegram chat.
IRC_SHOW_LOCATION_MESSAGE=falseIf a user shares their location on Telegram, this will forward the GPS coordinates of their location to IRC if set to true.
IRC_NO_FORWARD_PREFIX="[off]"A string users can prefix their message with to prevent it from being relayed across the bridge. Removing this option or setting it to “” disables it.
IRC_QUIT_MESSAGE="TeleIRC bridge stopped."A string that TeleIRC sends to the IRC channel when the application exits using IRC’s “QUIT” command. If not specified, it simply closes the connection without providing a reason. The bot must be connected to a server for a certain amount of time for the server to send the quit message to the channel.
Telegram settings
TELEGRAM_CHAT_ID=Telegram chat ID of bridged group (how do I get this?). Like: -0000000000000
Caution
Required setting (cannot be empty)
TELEIRC_TOKEN=Private API token for Telegram bot. Like: 000000000:AAAAAAaAAa2AaAAaoAAAA-a_aaAAaAaaaAA
Caution
Required setting (cannot be empty)
MAX_MESSAGE_PER_MINUTE=20Maximum number of messages sent per minute from IRC to Telegram.
IRC_PREFIX="<"Text displayed before IRC nickname in messages sent to Telegram
IRC_SUFFIX=">"Text displayed after IRC nickname in messages sent to Telegram
TELEGRAM_MESSAGE_REPLY_PREFIX="["Prefix separator for Telegram reply
TELEGRAM_MESSAGE_REPLY_SUFFIX="]"Suffix separator for Telegram reply
TELEGRAM_MESSAGE_REPLY_LENGTH=15Length of quoted reply message before truncation
SHOW_TOPIC_MESSAGE=falseSend Telegram message when the topic in the IRC channel is changed.
SHOW_ACTION_MESSAGE=trueRelay action messages (e.g.
/me thinks TeleIRC is cool!).SHOW_JOIN_MESSAGE=falseSend Telegram message when someone joins IRC channel.
JOIN_MESSAGE_ALLOW_LIST=""List of users (separated by a space character) whose IRC leave messages will be sent to Telegram, even if SHOW_JOIN_MESSAGE is false. This is ignored if SHOW_JOIN_MESSAGE is set to true.
SHOW_KICK_MESSAGE=falseSend Telegram message when someone is kicked from IRC channel.
SHOW_NICK_MESSAGE=falseSend Telegram message when someone changes their nickname in the IRC channel.
SHOW_LEAVE_MESSAGE=falseSend Telegram message when someone leaves IRC channel either by quitting or parting.
LEAVE_MESSAGE_ALLOW_LIST=""List of users (separated by a space character) whose IRC leave messages will be sent to Telegram, even if SHOW_LEAVE_MESSAGE is false. This is ignored if SHOW_LEAVE_MESSAGE is set to true.
SHOW_DISCONNECT_MESSAGE=falseSends a message to Telegram when the bot disconnects from the IRC side.
Imgur settings
IMGUR_CLIENT_ID=7d6b00b87043f58Imgur API client ID value to access Imgur API. Uses a default client ID. If you are bridging to a very active Telegram group, please :ref:`register your own application <imgur-setup>`.
IMGUR_CLIENT_SECRET=""Imgur API client secret. Only needed when uploading to an account.
IMGUR_REFRESH_TOKEN=""Imgur API refresh_token for the account where images should be uploaded. Only needed when uploading to an account.
IMGUR_ALBUM_HASH=""The album hash for the Imgur album uploaded images should belong to. How to find this