do6uk/meshcore_multitcp
1
0
Fork 0
mirror of https://github.com/do6uk/meshcore_multitcp.git synced 2026-04-21 03:53:36 +00:00
Code Issues Projects Releases Packages Wiki Activity

Revise README for improved instructions and details

Browse source 
Updated README to enhance clarity and add Docker usage instructions.
This commit is contained in:
mukowman 2026-02-19 22:11:53 +11:00 • committed by GitHub
parent 90139ed95b
commit 3274279558
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 124 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

146
README.md
View file

@ -1,6 +1,6 @@
# meshcore_multitcp
multiplexing a mescore tcp-connected companion to multiple clients as cli-chat, observer or bots
multiplexing a meshcore tcp-connected companion to multiple clients as cli-chat, observer or bots
## what you can do with this software
@ -9,42 +9,144 @@ multiplexing a mescore tcp-connected companion to multiple clients as cli-chat,
## what you will need
- companion radio with wifi-firmware to allow tcp-connections
- linux device (tested under debian trixie)
- python3
- python meshcore package (pip install meshcore)
- linux device (tested under debian trixie) **or Docker**
- python3 (not required when using Docker)
- python meshcore package (pip install meshcore) *(not required when using Docker)*
## usage
---
## usage (native Python)
```bash
python3 meshcore_multitcp.py -d Device-IP:PORT -s Server-IP:PORT [-q|-v]
```
-d sets IP & port of your companion radio
- **-d** sets IP & port of your companion radio
- **-s** sets IP & port of the machine this script listens to clients
- **-q** minimizes CLI-output
- **-v** maximizes CLI-output
- **-f** sets secondary IP & port for listening to clients using message-storage (see S&F)
- **-sql** activates message-storage for clients which connect at second ip/port given by `-f` (see S&F)
-s sets IP & port of the machine this script listens to clients
After meshcore_multitcp is running you can connect your clients to IP/port set with `-s`.
-q minimizes CLI-output
---
-v maximizes CLI-output
## 🐳 usage (Docker)
-f sets secondary IP & port for listening to clients using message-storage (see S&F)
You can run meshcore_multitcp in a container without installing Python or dependencies.
-sql activates message-storage for clients which connect at second ip/port given by -f (see S&F)
### Build the image
From the repository root:
After meshcore_multitcp is running you can connect your clients to IP/port set with -s
```bash
docker build -t meshcore-multitcp .
```
## S&F - store & forward messages
---
Using option -sql meshcore-multitcp will store all incomming private & channel messages in local sqlite3-database.
If client connects at secondary ip/port given by -f meshcore-multitcp will forward all stored messages since last message exchange.
Dumping large number of messages can cause hung up clients and messages could be lost.
### Run — basic mode
WARNING: Actually theres no database-clean-up - so if you connect a new client first time, meshcore-multitcp will try to forward all known messages.
Starts the proxy listening on port **5000** and connects to your companion radio.
```bash
docker run -d \
--name meshcore-multitcp \
-p 5000:5000 \
-e SERVER_ADDR="0.0.0.0:5000" \
-e DEVICE_ADDR="192.168.5.62:5000" \
meshcore-multitcp
```
Replace `192.168.5.62:5000` with your device IP and port.
Clients can then connect to:
```
<host-ip>:5000
```
---
### Run — Store & Forward (SQLite enabled)
Enables message storage and a secondary forwarding port.
```bash
docker run -d \
--name meshcore-multitcp \
-p 5000:5000 \
-p 5001:5001 \
-e SERVER_ADDR="0.0.0.0:5000" \
-e DEVICE_ADDR="192.168.5.62:5000" \
-e ENABLE_FORWARD="true" \
-e FORWARD_ADDR="0.0.0.0:5001" \
-e SQLITE="true" \
-v meshcore_data:/data \
meshcore-multitcp
```
---
### Logging options (Docker)
| LOG_LEVEL | Behaviour |
|-----------|-----------|
| `info` (default) | Standard output |
| `quiet` | Minimal logging |
| `debug` | Verbose logging |
Example:
```bash
-e LOG_LEVEL="debug"
```
---
### Environment variables (Docker)
| Variable | Required | Description |
|----------|----------|-------------|
| `SERVER_ADDR` | Yes | IP:PORT for clients to connect |
| `DEVICE_ADDR` | Yes | IP:PORT of companion radio |
| `ENABLE_FORWARD` | No | Enable secondary listener |
| `FORWARD_ADDR` | No | IP:PORT for store-forward clients |
| `SQLITE` | No | Enable message storage |
| `LOG_LEVEL` | No | `info`, `quiet`, or `debug` |
---
### Stop / remove container
```bash
docker stop meshcore-multitcp
docker rm meshcore-multitcp
```
---
## S&F — store & forward messages
Using option `-sql` (or `SQLITE=true` in Docker) meshcore-multitcp will store all incoming private & channel messages in a local sqlite3 database.
If a client connects at the secondary IP/port given by `-f` (or `FORWARD_ADDR` in Docker), meshcore-multitcp will forward all stored messages since the last message exchange.
Dumping a large number of messages can cause hung clients and messages could be lost.
⚠️ WARNING: There is currently no database clean-up.
If a new client connects for the first time, meshcore-multitcp will attempt to forward all stored messages.
---
## what you should know before you start
This software comes as it is without any guarantee to work stable and secure.
It contains modified parts of the original meshcore_py-scripts.
There are several things untested und a lot of bugs in it.
Some client-app functions doesn't work as expected and could throw timeout-errors or crash the whole app.
This software comes as it is without any guarantee to work stable and secure.
It contains modified parts of the original meshcore_py-scripts.
There are several things untested and a lot of bugs in it.
Some client-app functions don't work as expected and could throw timeout errors or crash the whole app.
TEST
---
## TEST