mirror of
https://github.com/zvx-echo6/meshai.git
synced 2026-05-21 23:24:44 +02:00
Document advBBS compatibility in README
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
247074afd1
commit
05a8f8659d
1 changed files with 19 additions and 0 deletions
19
README.md
19
README.md
|
|
@ -10,6 +10,7 @@ LLM-powered assistant for Meshtastic mesh networks.
|
||||||
- **Conversation History**: Per-user context maintained in SQLite
|
- **Conversation History**: Per-user context maintained in SQLite
|
||||||
- **Smart Chunking**: Automatically splits long responses for mesh transmission
|
- **Smart Chunking**: Automatically splits long responses for mesh transmission
|
||||||
- **Rate Limiting**: Configurable delays to avoid flooding the mesh
|
- **Rate Limiting**: Configurable delays to avoid flooding the mesh
|
||||||
|
- **advBBS Compatible**: Runs alongside [advBBS](https://github.com/NovaNexusMesh/advBBS) on the same node — protocol sync messages and mail notifications are automatically filtered
|
||||||
- **Rich Configurator**: Interactive TUI for easy setup
|
- **Rich Configurator**: Interactive TUI for easy setup
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
@ -188,6 +189,24 @@ LLM_API_KEY=your-key-here
|
||||||
docker compose logs -f meshai
|
docker compose logs -f meshai
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Running Alongside advBBS
|
||||||
|
|
||||||
|
MeshAI is designed to coexist with [advBBS](https://github.com/NovaNexusMesh/advBBS) on the same Meshtastic node. Both connect via TCP to meshtasticd and share the radio, but MeshAI automatically ignores advBBS traffic:
|
||||||
|
|
||||||
|
- **Sync protocol** — `MAILREQ|`, `MAILACK|`, `MAILDAT|`, `BOARDREQ|`, etc.
|
||||||
|
- **RAP protocol** — `advBBS|` pings, pongs, and route advertisements
|
||||||
|
- **Mail notifications** — `[MAIL]` new message alerts
|
||||||
|
- **Bang commands in DMs** — `!mail`, `!board`, etc. are left for advBBS to handle
|
||||||
|
|
||||||
|
No special configuration is needed. The filter is enabled by default and can be toggled in `config.yaml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
bot:
|
||||||
|
filter_bbs_protocols: true # set false to disable
|
||||||
|
```
|
||||||
|
|
||||||
|
Plain-text BBS responses (e.g. "Welcome back, matt!") are indistinguishable from normal user messages and will be processed normally — this is a known and accepted limitation.
|
||||||
|
|
||||||
## Running as a Service
|
## Running as a Service
|
||||||
|
|
||||||
Create `/etc/systemd/system/meshai.service`:
|
Create `/etc/systemd/system/meshai.service`:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue