mc-webui

A lightweight web interface providing browser-based access to MeshCore mesh network.

Overview

mc-webui is a Flask-based web application providing browser-based access to MeshCore mesh network. It communicates directly with your LoRa device (via USB, BLE, or TCP) using the meshcore Python library, eliminating the need for SSH/terminal access. Tested on Heltec V3 and Heltec V4.

Key Features

• Mobile-first design - Responsive UI optimized for small screens, with desktop sidebar for wide screens
• Channel management - Create, join, share (QR code), and switch between encrypted channels
• Direct Messages (DM) - Private messaging with searchable contact selector, delivery tracking, configurable retry strategy, and multi-path routing
• Smart notifications - Unread message counters per channel with cross-device sync
• Contact management - Manual approval, add via URI/QR, filtering, protection, ignoring, blocking, batch operations, and cleanup tools
• Global search - Full-text search across all messages (channels and DMs) with FTS5 backend
• Database - Fast and reliable SQLite storage for messages, contacts, and configurations
• Contact map - View contacts and own device on OpenStreetMap (Leaflet) with last seen info
• Message archives - Automatic daily archiving with browse-by-date selector
• Interactive Console - Full MeshCore command suite via WebSocket — repeater, contact, device, and channel management
• Device dashboard - Device info, statistics, and contact sharing (QR code / URI)
• Dark/Light theme - Toggle between dark and light UI themes
• Settings - Configurable DM retry parameters, message retention, quote length, and theme
• System Log - Real-time log viewer with streaming
• Database backup - Create, list, and download database backups from the UI
• @Mentions autocomplete - Type @ to see contact suggestions with fuzzy search
• Echo tracking - "Heard X repeats" with repeater IDs for sent messages, all route paths for incoming messages with deterministic payload matching (persisted across restarts)
• MeshCore Analyzer - View packet details on analyzer.letsmesh.net directly from channel messages
• DM delivery tracking - ACK-based delivery confirmation with SNR and route info
• Multi-device support - Database file named after device public key for easy multi-device setups
• PWA support - Browser notifications and installable app (experimental)
• Full offline support - Works without internet (local Bootstrap, icons, emoji picker)

For detailed feature documentation, see the User Guide.

Quick Start

Prerequisites

1. Meshcore Device (tested on Heltec V4)

• Flash the device at https://flasher.meshcore.co.uk/. Choose the Companion USB role.
• Configure the device with the Meshcore mobile app (from Google Play Store / App Store): Name, Location (optional), Preset

2. Linux Server

• Git installed
• Docker and Docker Compose installed (installation guide)

Important Notes:

• Powered by direct meshcore library integration (v2 architecture)
• No manual directory setup needed - all data stored in ./data/ inside the project directory
• Uses a single-container architecture with a fast SQLite database

---

Installation

1. Clone the repository

   cd ~
   git clone https://github.com/MarekWo/mc-webui
   cd mc-webui
   

2. Create configuration file

   cp .env.example .env
   

   In most cases, no changes are needed! The defaults work automatically:

   • MC_SERIAL_PORT=auto - auto-detects your USB device
   • MC_DEVICE_NAME=auto - auto-detects device name from meshcli

   Optionally edit .env to set your timezone: TZ=Europe/Warsaw

   Troubleshooting: Multiple USB devices or detection fails

   Check available serial devices:

   ls /dev/serial/by-id/
   

   If you see multiple devices, edit .env and set MC_SERIAL_PORT explicitly:

   MC_SERIAL_PORT=/dev/serial/by-id/usb-Espressif_Systems_heltec_...
   

3. Verify Serial Device Permissions (if needed)

   sudo usermod -aG dialout $USER
   # Log out and log back in for changes to take effect
   

4. Build and run

   python3 -m app.version freeze
   docker compose up -d --build
   

   This will:

   • Download base images (Python, Alpine Linux)
   • Install the meshcore Python library
   • Create ./data/ directory structure automatically
   • Start the mc-webui container

5. Verify installation

   docker compose ps
   

   The container should show Up status. Check logs if needed:

   docker compose logs -f
   

6. Access the web interface

   Open your browser and navigate to:

   http://<your-server-ip>:5000
   

   To find your server IP: hostname -I | awk '{print $1}'

7. Initial Configuration (In Web UI)

   • Main page loads with chat interface on "Public" channel
   • Wait for initial sync (1-2 minutes)
   • Optional: Enable manual contact approval in Contact Management

---

Basic Usage

1. View messages - Main page shows chat history with auto-refresh every 10 seconds
2. Send messages - Type in the text field and press Enter (135 bytes for channels, 150 bytes for DM)
3. Switch channels - Use the dropdown in navbar
4. Direct Messages - Access via menu (☰) → "Direct Messages"
5. Manage contacts - Access via menu (☰) → "Contact Management"
6. Console - Access via menu (☰) → "Console" for MeshCore commands
7. Search - Access via menu (☰) → "Search" for full-text message search
8. Settings - Access via menu (☰) → "Settings" for DM retry and other configuration

For complete usage instructions, see the User Guide.

---

Updating

Using the update script (recommended)

The easiest way to update mc-webui:

cd ~/mc-webui
./scripts/update.sh

The script automatically pulls changes, freezes the version, and rebuilds containers.

Optional: Create a global alias for quick updates

Add to your ~/.bashrc or ~/.zshrc:

alias mcupdate='~/mc-webui/scripts/update.sh'

Then reload your shell (source ~/.bashrc) and update anytime with:

mcupdate

Manual update

If you prefer to run commands manually:

cd ~/mc-webui
git pull
python3 -m app.version freeze
docker compose up -d --build

The python3 -m app.version freeze command captures the current Git version (date + commit hash) for display in the app menu.

Testing experimental features

The dev branch contains new features that are still being tested:

cd ~/mc-webui
git checkout dev
./scripts/update.sh

To return to the stable version:

cd ~/mc-webui
git checkout main
./scripts/update.sh

Remote updates from web GUI (optional)

You can enable one-click updates directly from the mc-webui menu. This requires installing a small webhook service on the host machine.

Install the updater service:

cd ~/mc-webui
sudo ./scripts/updater/install.sh

The installer will:

• Create a systemd service mc-webui-updater
• Start a webhook server on port 5050 (localhost only)
• Enable automatic startup on boot

Usage:

1. Click the refresh button (↻) next to the version in the menu
2. If an update is available, an "Update" button appears
3. Click "Update" to trigger the update remotely
4. The app will automatically reload when the update completes

Useful commands:

# Check service status
systemctl status mc-webui-updater

# View logs
journalctl -u mc-webui-updater -f

# Uninstall
sudo ~/mc-webui/scripts/updater/install.sh --uninstall

Security note: The webhook listens only on localhost. The Docker container connects to it via the Docker bridge network.

---

Gallery

Main Window	Direct Messages	Unread Messages	Message Archive
Menu (1)	Menu (2)	Device Info	Update Check
Update Available	Remote Update	Updated Successfully	Meshcli Console
Contact Management	Existing Contacts	Approve Contact	Channel Management
Global Search	Message Filtering	Settings	System Log
Map	Map (Individual)	Image Preview (1)	Image Preview (2)

---

Documentation

Document	Description
User Guide	Complete feature documentation
Architecture	Technical details, API reference
Troubleshooting	Common issues and solutions
Docker Installation	How to install Docker on Debian/Ubuntu
Container Watchdog	Auto-restart for unhealthy containers

---

Development Status

Completed Features

• Environment Setup & Docker Architecture (single-container, direct device access)
• Backend Basics (REST API, SQLite database, meshcore library integration)
• Frontend Chat View (Bootstrap UI, message display, quote/reply)
• Message Sending (Send form, reply, quote with configurable length)
• Intelligent Auto-refresh (10s checks, UI updates only when needed)
• Contact Management (Approval, add via URI/QR, filtering, protection, ignore/block, batch operations, cleanup)
• Channel Management (Create, join, share via QR, delete with auto-cleanup)
• Public Channels (# prefix support, auto-key generation)
• Message Archiving (Daily archiving with browse-by-date selector)
• Smart Notifications (Unread counters per channel and total)
• Direct Messages (DM) - Searchable contact selector, delivery tracking, configurable retry, multi-path routing
• Global Message Search - Full-text search across channels and DMs (FTS5)
• Message Content Enhancements - Mention badges, clickable URLs, image previews
• @Mentions Autocomplete - Type @ to get contact suggestions with fuzzy search
• PWA Notifications (Experimental) - Browser notifications and app badge counters
• Full Offline Support - Local Bootstrap libraries and Service Worker caching
• Interactive Console - Full MeshCore command suite (repeater, contact, device, channel management)
• Contact Map - View contacts and own device on OpenStreetMap (Leaflet)
• Echo Tracking - "Heard X repeats" badge for sent channel messages
• MeshCore Analyzer - Packet analysis links on channel messages (analyzer.letsmesh.net)
• DM Delivery Tracking - ACK-based delivery checkmarks with SNR/route details
• Device Dashboard - Device info, statistics, and contact sharing (QR/URI)
• Settings Modal - DM retry parameters, message retention, and dark/light theme
• System Log - Real-time log viewer with streaming
• Database Backup - Create, list, and download backups from the UI
• Desktop Sidebar - Channel/contact sidebar for wide screens (tablet/desktop)
• Dark/Light Theme - Toggle between dark and light UI themes
• Multi-device Support - Database file named after device public key

Next Steps

• Performance Optimization - Frontend and backend improvements
• Enhanced Testing - Unit and integration tests

---

Security Notes

Important: This application is designed for trusted local networks only and has no authentication. Do not expose it to the internet without implementing proper security measures.

---

Contributing

This is an open-source project. Contributions are welcome!

• All code, comments, and documentation must be in English
• Follow the existing code style
• Test your changes with real hardware if possible

---

License

---

References

• MeshCore Documentation
• meshcore Python library

---

Buy me a coffee

If you appreciate what I am doing you can buy me a coffee :)

Thanks!

Contact