Docker Compose Configurator

MeshMonitor Docker Compose Configurator

Configure your MeshMonitor deployment by selecting your options below. This tool will generate a ready-to-use docker-compose.yml and .env file for your setup.

1. Connection Type

How is your Meshtastic node connected?

TCP/NetworkDirect network connection (WiFi/Ethernet)

Bluetooth (BLE)Bluetooth Low Energy connection via BLE Bridge

USB/SerialUSB or serial connection via Serial Bridge

2. Connection Details

Node IP Address

The IP address of your Meshtastic node

Node TCP Port

Default is 4403

3. Deployment Mode

How will you access MeshMonitor?

Development (HTTP)Simple HTTP access via localhost or local IP

Production with Reverse ProxyHTTPS via nginx, Caddy, or Traefik (recommended)

Production without Reverse ProxyDirect HTTP access (not recommended)

4. Port Configuration

Web Interface Port

Port to access MeshMonitor web interface

5. Security Settings

Enable Virtual NodeAllows multiple Meshtastic mobile apps to connect simultaneously

Disable Anonymous AccessRequire authentication for all access

Virtual Node Port

Port for Meshtastic mobile apps to connect (default: 4404)

Allow Admin Commands⚠️ Allow admin commands through virtual node (reduces security, use only if multiple services need access)

6. Additional Settings

Timezone

Your timezone (e.g., America/New_York, Europe/London, Asia/Tokyo) See list

Enable Automatic Self-Upgrade

Adds a watchdog sidecar container that allows one-click upgrades through the web UI. Learn more

Enable Offline Map Tiles (TileServer GL Light)

Adds a TileServer GL Light container for serving offline map tiles. Supports both vector (.pbf) and raster (.png) tiles for full offline operation.

Mount Auto Responder Scripts Directory

Mounts ./scripts to /data/scripts for easy management of Auto Responder scripts. Learn more

Enable MQTT Client Proxy Sidecar

Adds an MQTT proxy container that routes MQTT traffic through MeshMonitor instead of directly from your node. Useful when your node has unreliable WiFi or when you want MQTT without running mobile apps. Learn more

7. Generated Configuration

docker-compose.yml

services:
  meshmonitor:
    image: ghcr.io/yeraze/meshmonitor:latest
    container_name: meshmonitor
    ports:
      - "8080:3001"
      - "4404:4404"
    restart: unless-stopped
    volumes:
      - meshmonitor-data:/data
    env_file: .env
    environment:
      - NODE_ENV=development
      - TZ=America/New_York
      - MESHTASTIC_NODE_IP=192.168.1.100
      - ALLOWED_ORIGINS=http://localhost:8080
      - ENABLE_VIRTUAL_NODE=true

volumes:
  meshmonitor-data:
    driver: local

.env

# MeshMonitor Configuration
# Generated by MeshMonitor Docker Compose Configurator

Deployment Instructions

1. Copy the docker-compose.yml content above and save it to a file named docker-compose.yml
2. Copy the .env content above and save it to a file named .env in the same directory
3. Run docker compose up -d to start MeshMonitor
4. Access MeshMonitor at http://localhost:8080

Need Help?

If you encounter any issues with your configuration:

• Connection issues: See our troubleshooting guides
• BLE setup: Check the BLE Bridge documentation
• Serial/USB setup: Check the Serial Bridge documentation
• MQTT Proxy setup: Check the MQTT Client Proxy documentation
• Production deployment: Review the Production Deployment guide
• Reverse proxy: See Reverse Proxy Configuration

What's Next?

After deploying with the generated configuration:

1. Configure your node: Make sure your Meshtastic device is properly configured
2. Set up notifications: Configure push notifications for alerts
3. Security: Review security best practices
4. Backups: Set up automated backups
5. Monitoring: Configure health checks and monitoring

Configuration Options Explained

Connection Types

• TCP/Network: For devices with WiFi or Ethernet connectivity. This is the most straightforward option and provides the best performance.
• Bluetooth (BLE): For devices that only have Bluetooth connectivity. Requires the BLE Bridge and a system with Bluetooth hardware.
• USB/Serial: For devices connected via USB or serial port. Requires the Serial Bridge and the device to be physically connected to your server.

Deployment Modes

• Development (HTTP): Best for local testing and home use. Simple HTTP access without SSL/TLS.
• Production with Reverse Proxy: Recommended for production deployments. Uses HTTPS via a reverse proxy like nginx, Caddy, or Traefik.
• Production without Reverse Proxy: Direct HTTP access in production. Not recommended due to lack of encryption.

Security Options

• Virtual Node: When enabled, allows multiple Meshtastic mobile apps to connect to MeshMonitor simultaneously without overwhelming your physical node. Highly recommended.
• Disable Anonymous Access: When enabled, users must authenticate before accessing MeshMonitor. Useful for deployments accessible from the internet.

Additional Settings

• Automatic Self-Upgrade: Enable one-click upgrades through the web UI with the upgrade watchdog sidecar.
• Offline Map Tiles: Add TileServer GL for serving offline map tiles when internet connectivity is limited.
• Auto Responder Scripts: Mount a scripts directory for custom automation scripts.
• MQTT Client Proxy: Route MQTT traffic through MeshMonitor instead of your node's WiFi. Useful for nodes with unreliable connectivity or when using Serial/BLE connections. See MQTT Client Proxy documentation.

Advanced Topics

For more complex deployments, check out these resources:

• Kubernetes/Helm Deployment
• High Availability Setup
• SSO/OIDC Authentication
• Custom SSL Certificates
• Database Optimization
• MQTT Client Proxy - Reliable MQTT for nodes with unreliable WiFi