reticulum-meshchat/README.md

109 lines
4.3 KiB
Markdown
Raw Normal View History

2024-04-30 18:15:32 +12:00
<p align="center">
<a href="https://github.com/liamcottle/reticulum-webchat"><img src="./logo/logo-chat-bubble.png" width="150"></a>
</p>
<h2 align="center">Reticulum WebChat</h2>
2024-04-30 18:17:20 +12:00
<p align="center">
<a href="https://discord.gg/APQSQZNV7t"><img src="https://img.shields.io/badge/Discord-Liam%20Cottle's%20Discord-%237289DA?style=flat&logo=discord" alt="discord"/></a>
<a href="https://twitter.com/liamcottle"><img src="https://img.shields.io/badge/Twitter-@liamcottle-%231DA1F2?style=flat&logo=twitter" alt="twitter"/></a>
<br/>
<a href="https://ko-fi.com/liamcottle"><img src="https://img.shields.io/badge/Donate%20a%20Coffee-liamcottle-yellow?style=flat&logo=buy-me-a-coffee" alt="donate on ko-fi"/></a>
<a href="./donate.md"><img src="https://img.shields.io/badge/Donate%20Bitcoin-3FPBfiEwioWHFix3kZqe5bdU9F5o8mG8dh-%23FF9900?style=flat&logo=bitcoin" alt="donate bitcoin"/></a>
</p>
2024-04-30 18:15:32 +12:00
## What is Reticulum WebChat?
2024-04-29 04:35:58 +12:00
2024-04-30 15:50:15 +12:00
A simple open-source web based [LXMF](https://github.com/markqvist/lxmf) client for [Reticulum](https://github.com/markqvist/Reticulum).
2024-04-29 04:35:58 +12:00
2024-05-01 00:07:17 +12:00
<img src="./screenshots/screenshot.png">
2024-04-29 04:35:58 +12:00
## Features
2024-04-30 21:46:26 +12:00
- Supports sending and receiving messages between [Reticulum WebChat](https://github.com/liamcottle/reticulum-webchat), [Sideband](https://github.com/markqvist/Sideband/) and [Nomadnet](https://github.com/markqvist/nomadnet).
2024-04-30 15:50:15 +12:00
- Supports receiving and saving images and attachments sent from Sideband.
- Supports sending an announce to the network.
- Supports setting a custom display name to send in your announce.
- Supports viewing peers discovered from announces.
2024-04-29 04:35:58 +12:00
## How does it work?
2024-04-29 16:41:57 +12:00
- A python script ([web.py](./web.py)) runs a Reticulum instance and a WebSocket server.
2024-04-29 04:35:58 +12:00
- The web page sends and receives lxmf packets encoded in json via the WebSocket.
- Web Browser -> WebSocket -> Python Reticulum -> (configured interfaces) -> (destination)
2024-04-29 04:37:41 +12:00
## 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
2024-04-29 14:59:45 +12:00
pip install -r requirements.txt
2024-04-29 04:37:41 +12:00
python web.py
```
2024-04-29 04:35:58 +12:00
2024-04-29 14:54:13 +12:00
> NOTE: You should now be able to access the web interface at http://localhost:8000
2024-04-29 16:45:06 +12:00
For a full list of command line options, you can run;
```
python web.py --help
```
```
usage: web.py [-h] [--host [HOST]] [--port [PORT]] [--identity-file IDENTITY_FILE] [--identity-base64 IDENTITY_BASE64]
ReticulumWebChat
options:
-h, --help show this help message and exit
--host [HOST] The address the web server should listen on.
--port [PORT] The port the web server should listen on.
--identity-file IDENTITY_FILE
Path to a Reticulum Identity file to use as your LXMF address.
--identity-base64 IDENTITY_BASE64
A base64 encoded Reticulum Identity to use as your LXMF address.
```
2024-04-29 16:10:10 +12:00
## Using an existing Reticulum Identity
By default, a random identity is generated every time you run the script.
2024-04-29 16:10:10 +12:00
This is handy for quickly testing out the web ui, however you may want to use an existing identity when chatting with others.
2024-04-29 16:10:10 +12:00
To generate a new identity, you can use the [rnid](https://reticulum.network/manual/using.html#the-rnid-utility) utility provided by Reticulum.
2024-04-29 16:10:10 +12:00
```
rnid --generate ./new_identity
```
2024-04-29 16:46:05 +12:00
You can then use following to run the web ui with your new identity file;
```
python web.py --identity-file ./new_identity
```
Alternatively, you can provide a base64 encoded private key, like so;
```
python web.py --identity-base64 "GCN6mMhVemdNIK/fw97C1zvU17qjQPFTXRBotVckeGmoOwQIF8VOjXwNNem3CUOJZCQQpJuc/4U94VSsC39Phw=="
2024-04-29 16:10:10 +12:00
```
> NOTE: this is a randomly generated identity for example purposes. Do not use it, it has been leaked!
2024-04-29 04:44:42 +12:00
## TODO
2024-04-30 23:39:52 +12:00
- [ ] search peers by name and address
2024-04-30 21:43:05 +12:00
- [ ] add screenshot of web ui to readme
2024-04-29 04:49:37 +12:00
- [ ] send images from web ui
- [ ] send file attachments from web ui
2024-04-30 15:51:41 +12:00
- [ ] support saving conversation history across page reloads, maybe an sqlite database
- [ ] conversations/contacts list ui with unread indicators
2024-04-30 15:50:15 +12:00
- [ ] button to add peer to contacts, and show a tab for contacts
- [ ] allow setting a custom name to show for a contact
- [ ] button to forget peers and contacts
2024-04-30 21:07:01 +12:00
- [ ] optimise ui to work nicely on a mobile device, such as Android/iOS
2024-04-30 21:15:31 +12:00
- [ ] support for exploring/navigating a nodes micron pages
2024-04-30 21:16:02 +12:00
- [ ] support for managing Reticulum config/interfaces via the web ui