fishroom

Message forwarding for multiple IM protocols.

  

Motivation

TUNA needs a chatroom, while each IM protocol/software has its own implementation for chatroom.

Unlike email and mailing list, instant messaging is fragmented: everyone prefers different softwares. As a result, people of TUNA are divided by the IM they use, be it IRC, wechat, telegram, or XMPP.

To reunify TUNA, we created this project to relay messages between IM clients, so that people can enjoy a big party again.

Supported IMs

• IRC
• XMPP
• Matrix
• Telegram
• Gitter
• Actor (not yet)
• Tox (not yet)
• Wechat (maybe)

Basic Architecture

Fishroom consists of a fishroom core process, which routes messages among IMs and process commands, and several IM handler processes to deal with different IMs. These components are connected via Redis pub/sub.

+----------+
| IRC      |<-+
+----------+  |
+----------+  |
| XMPP     |<-+
+----------+  |
+----------+  |    +-------+       +---------------+
| Telegram |<-+--> | Redis | <---> | Fishroom Core |
+----------+  |    +-------+       +---------------+
+----------+  |
| Gitter   |<-+
+----------+  |
+----------+  |
| Web      |<-+
+----------+

How to Use

Clone me first

git clone https://github.com/tuna/fishroom
cd fishroom

Install and run redis first, assuming you use ubuntu or debian.
apt-get install redis
Modify the config file, the redis server should be on addr 127.0.0.1 and port 6379.
mv fishroom/config.py.example fishroom/config.py
vim fishroom/config.py
Ensure your python version is at least 3.5, next, we install the dependencies for fishroom.
apt-get install -y python3-dev python3-pip libmagic1 libjpeg-dev libpng-dev libwebp-dev zlib1g-dev gcc
pip3 install --upgrade pip setuptools
pip3 install -r requirements.txt
Run fishroom and fishroom web.
# run fishroom core
python3 -m fishroom.fishroom

# start IM interfaces, select not all of them are needed
python3 -m fishroom.telegram
python3 -m fishroom.IRC
python3 -m fishroom.gitter
python3 -m fishroom.xmpp

python3 -m fishroom.web
Open your browser, and visit http://127.0.0.1:8000/, you should be able to view the web UI of fishoom.
Good Luck!
Related Projects
Telegram2IRC
Telegram Bot API
IRCBindXMPP
SleekXMPP
Multi-User Chat Supported (http://sleekxmpp.com/getting_started/muc.html)
Tox-Sync
qwx
from https://github.com/tuna/fishroom