reticulum-meshchatX/README.md

Reticulum WebChat

A simple web based LXMF client for Reticulum.

Features

• Supports sending to and receiving messages from Sideband and Nomadnet.
• Supports receiving images sent from Sideband.
• Supports receiving file attachments sent from Sideband.

How does it work?

• A python script (web.py) runs a Reticulum instance and a WebSocket server.
• The web page sends and receives lxmf packets encoded in json via the WebSocket.
• Web Browser -> WebSocket -> Python Reticulum -> (configured interfaces) -> (destination)

How to use it?

You will need to clone the repo, and run web.py.

git clone https://github.com/liamcottle/reticulum-webchat
cd reticulum-webchat
python web.py

TODO

• serve index.html from web.py on the same port as websocket
• allow passing in a custom Reticulum config file via cli args
• create/import/export identities in the web ui
• ui to configure custom name to send in announcement app data
• ui to view announcements, with names from app data
• support saving conversation history across page reloads