rusjpmd/meshdash-runner repository overview

⁠MeshDash - Advanced Meshtastic Dashboard

MeshDash is a powerful, persistent web dashboard for your Meshtastic nodes. It logs packet history, visualizes telemetry, manages messages, and provides a sleek interface for controlling your mesh hardware.

This container runs the full MeshDash backend (FastAPI/Python) and frontend. It is designed to be deployed in seconds using the MeshDash Cloud Setup.

The runner container handles installation and automatically manages updates to the latest version of MeshDash on boot.

All source code is open source and can be found on the MeshDash website.

🔗 Generate your install command at: https://meshdash.co.uk/⁠

---

⁠🚀 Quick Start (Recommended)

The easiest way to get running is to generate a configuration profile on our website. You do not need to manually edit config files or map complex volumes yourself.

1. Go to https://meshdash.co.uk/⁠
2. Use the setup tool to define your settings (Serial Port, Node preferences, Map settings).
3. Copy your unique API Key and the generated Docker command.
4. Run the command on your host (Raspberry Pi, VPS, Server).

The container will automatically fetch your configuration on the first boot, install the latest version of the dashboard, and initialize the system.

⁠Docker Run Command

docker run -d
--name meshdash
--restart always
--network host
--privileged
-v /dev:/dev
-v meshdash_data:/app/data
-e MD_SETUP_KEY="YOUR_API_KEY_HERE"
-e MD_SETUP_URL="https://meshdash.co.uk/user_setup_core.php⁠"
rusjpmd/meshdash-runner:latest

(Replace YOUR_API_KEY_HERE with the key provided during the setup process on the website).

---

⁠🌟 Key Features

Based on the robust meshdash-runner backend, this container offers:

• Automatic Updates: The container checks for and installs the latest MeshDash version automatically on boot.
• Persistent Database: Uses SQLite to store node lists, message history, and telemetry logs even when the node restarts.
• Interactive Map: Visualizes node positions, traceroutes, and waypoints.
• Telemetry & Graphs: Tracks battery levels, signal-to-noise ratio (SNR), and environmental metrics over time.
• Full Messaging: Send and receive private DMs and channel broadcasts with a chat-log history.
• Hardware Control:
  • GPIO Control: Toggle pins on remote nodes via the Admin interface.
  • Admin Actions: Remote reboot, shutdown, and node management.
• Automation: Built-in Auto-Reply system and Task Scheduler.
• C2 Bridge: Optional Command & Control bridging for remote management over the internet.

---

⁠⚙️ Configuration Methods

Method 1: Cloud Auto-Config (The MD_SETUP_KEY) When the container starts with the MD_SETUP_KEY environment variable, it securely connects to the MeshDash server. It downloads your specific settings and applies them immediately. This makes deploying to headless Raspberry Pis incredibly fast.

Method 2: Manual Configuration (Advanced) If you prefer not to use the cloud setup, you can manually configure the application. Instructions for manual configuration are available on the MeshDash website.

---

⁠📂 Volumes & Permissions

--network host Required. Allows the container to access the host's networking stack to communicate with local Meshtastic devices via TCP/HTTP or local discovery.

--privileged Required for Serial/USB. Allows the container to access /dev/ttyUSB* or /dev/ttyACM* devices to communicate with the radio.

-v /dev:/dev Maps the host device tree so the container can see the Meshtastic hardware.

-v meshdash_data:/app/data Persists your database (meshdash_data.db), logs, and local settings so data isn't lost on container updates.

---

⁠📡 Hardware Support

This image supports connecting to Meshtastic nodes via:

• Serial/USB: (Recommended) Direct connection via USB cable to the host.
• TCP/WiFi: Connection to a node on the local network via IP address.

Note: You must define your connection type during the setup wizard on https://meshdash.co.uk/⁠

---

⁠🛠 Troubleshooting

I don't see my radio connecting: Check the logs to see if the serial port was detected: docker logs -f meshdash

Ensure you included --privileged and -v /dev:/dev in your run command.

Where is the dashboard? By default, the dashboard runs on port 8000. Access it via: http://:8000