35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
# Reticulum WebChat
|
|
|
|
A simple web based [LXMF](https://github.com/markqvist/lxmf) client for [Reticulum](https://github.com/markqvist/Reticulum).
|
|
|
|
## Features
|
|
|
|
- Supports sending to and receiving messages from [Sideband](https://github.com/markqvist/Sideband/) and [Nomadnet](https://github.com/markqvist/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
|