mirror of
https://github.com/pablorevilla-meshtastic/meshview.git
synced 2026-03-04 23:27:46 +01:00
Update README.md
first mention of config.ini
This commit is contained in:
@@ -1,19 +1,17 @@
|
||||
Meshview
|
||||
========
|
||||
|
||||
Now running at https://meshview.bayme.sh
|
||||
# Meshview
|
||||
|
||||
This project watches a MQTT topic for meshtastic messages, imports them to a
|
||||
database and has a web UI to view them.
|
||||
Requires Python 3.12
|
||||
|
||||
Running
|
||||
-------
|
||||
## Preparing
|
||||
|
||||
Clone the repo from github with:
|
||||
``` bash
|
||||
git clone --recurse-submodules https://github.com/pablorevilla-meshtastic/meshview.git
|
||||
```
|
||||
It is important to include the `--recurse-submodules` flag or the meshtastic protobufs wont be included
|
||||
> [!NOTE]
|
||||
> It is important to include the `--recurse-submodules` flag or the meshtastic protobufs won't be included.
|
||||
|
||||
Create a python virtual environment:
|
||||
``` bash
|
||||
@@ -28,23 +26,16 @@ You also need to install `graphviz`:
|
||||
``` bash
|
||||
sudo apt-get install graphviz
|
||||
```
|
||||
Edit `config.ini` to change the MQTT server and topic
|
||||
|
||||
Other Options:
|
||||
* `port`
|
||||
|
||||
Web server port, default is `8081`
|
||||
|
||||
## Running Meshview
|
||||
|
||||
To run Meshview:
|
||||
``` bash
|
||||
./env/bin/python main.py
|
||||
```
|
||||
Now you can hit http://localhost/
|
||||
|
||||
Other Options:
|
||||
* `--port`
|
||||
|
||||
Web server port, default is `8081`
|
||||
|
||||
* `--mqtt-server`
|
||||
|
||||
MQTT Server, default is `mqtt.bayme.sh`
|
||||
|
||||
* `--topic`
|
||||
|
||||
MQTT Topic, default is `msh/US/bayarea/#`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user