MeshMonitor v2.3.0 - Comprehensive Feature Documentation ๐
This release introduces comprehensive online documentation with in-app contextual help links, making MeshMonitor easier to learn and use.
๐ What's New
Documentation Website
- New Website: Complete documentation now live at meshmonitor.org
- Features Section: Three comprehensive guides covering all MeshMonitor capabilities
- In-App Help: Question mark (โ) icons throughout the UI link directly to relevant documentation
Feature Documentation
๐ Settings Documentation
Complete guide to MeshMonitor settings:
- Node display configuration
- Display preferences (units, formats, sorting)
- Telemetry visualization settings
- Settings management
- Danger zone operations with detailed warnings
๐ค Automation Documentation
Detailed documentation for all automation features:
- Auto Acknowledge: Regex-based automatic message responses with pattern testing
- Auto Traceroute: Periodic network topology mapping
- Auto Announce: Scheduled announcements with dynamic tokens ({VERSION}, {DURATION}, {FEATURES}, etc.)
Each feature includes configuration details, side effects, use cases, and best practices.
โ๏ธ Device Configuration Documentation
Comprehensive guide to device configuration:
- Node Identity: Long and short name configuration
- Device Roles: Detailed descriptions of all 12 roles (CLIENT, ROUTER, TRACKER, SENSOR, etc.)
- LoRa Radio: 8 modem presets and 15 regional configurations
- Position Settings: Broadcast intervals, smart position, fixed position
- MQTT Integration: Broker configuration, encryption, JSON mode
- Neighbor Info Module: Network topology data collection
In-App Help Links
Help icons (โ) added to all major sections:
- Settings tab header
- All automation sections (Auto Acknowledge, Auto Traceroute, Auto Announce)
- All device configuration sections (Node Identity, Device Config, LoRa, Position, MQTT, Neighbor Info)
All links open in a new tab pointing to the specific documentation section at meshmonitor.org.
๐ Documentation Features
- Clear explanations of each feature and setting
- Side effects and impacts clearly documented
- Best practices and recommendations
- Links to official Meshtastic documentation
- Warning callouts for dangerous operations
- Real-world use case examples
๐ Quick Links
- Website: meshmonitor.org
- Getting Started: meshmonitor.org/getting-started
- Features: meshmonitor.org/features/settings
- Configuration: meshmonitor.org/configuration/
๐ฆ Installation
Docker
docker run -d -p 8080:8080 \
-e MESHTASTIC_NODE_IP=192.168.1.100 \
-e SESSION_SECRET=$(openssl rand -base64 32) \
-e COOKIE_SECURE=false \
ghcr.io/yeraze/meshmonitor:v2.3.0Docker Compose
version: '3.8'
services:
meshmonitor:
image: ghcr.io/yeraze/meshmonitor:v2.3.0
ports:
- "8080:8080"
environment:
- MESHTASTIC_NODE_IP=192.168.1.100
- SESSION_SECRET=change-this-to-a-random-string
- COOKIE_SECURE=false
volumes:
- meshmonitor_data:/app/data
volumes:
meshmonitor_data:Kubernetes / Helm
helm install meshmonitor oci://ghcr.io/yeraze/meshmonitor/helm/meshmonitor --version 2.3.0๐ Thanks
Thank you to everyone using MeshMonitor and providing feedback. The documentation was created based on common questions and user needs.
Full Changelog: v2.2.2...v2.3.0
What's Changed
- Add VitePress Documentation Website by @Yeraze in #175
- docs: configure custom domain meshmonitor.org by @Yeraze in #177
- fix: add hero image to public directory by @Yeraze in #178
- docs: add comprehensive feature documentation with in-app help links by @Yeraze in #179
- chore: bump version to 2.3.0 by @Yeraze in #180
Full Changelog: v2.2.2...v2.3.0
๐ MeshMonitor v2.3.0
๐ฆ Installation
Docker (recommended):
docker run -d \
--name meshmonitor \
-p 8080:3001 \
-v meshmonitor-data:/data \
ghcr.io/Yeraze/meshmonitor:v2.3.0๐งช Testing
โ
All tests passed
โ
TypeScript checks passed
โ
Docker images built for linux/amd64, linux/arm64, linux/arm/v7
๐ Changes
See commit history for detailed changes.