mmrelay 1.2.4

Bridge between Meshtastic mesh networks and Matrix chat rooms

MMRelay

(Meshtastic <=> Matrix Relay)

A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to many other platforms.

Features

• Bidirectional message relay between Meshtastic devices and Matrix chat rooms, capable of supporting multiple meshnets
• Supports serial, network, and BLE (now too!) connections for Meshtastic devices
• Custom fields are embedded in Matrix messages for relaying messages between multiple meshnets
• Truncates long messages to fit within Meshtastic's payload size
• SQLite database to store node information for improved functionality
• Customizable logging level for easy debugging
• Configurable through a simple YAML file
• Supports mapping multiple rooms and channels 1:1
• Relays messages to/from an MQTT broker, if configured in the Meshtastic firmware
• ✨️ Bidirectional replies and reactions support ✨️
• ✨️ Native Docker support ✨️
• 🔐 Matrix End-to-End Encryption (E2EE) support 🔐 NEW in v1.2!

MMRelay v1.2 introduces Matrix End-to-End Encryption support for secure communication in encrypted rooms. Messages are automatically encrypted/decrypted when communicating with encrypted Matrix rooms, with simple setup using mmrelay auth login or automatic credentials creation from config.yaml.

Documentation

MMRelay supports multiple deployment methods including Docker, pip installation, and standalone executables. For complete setup instructions and all deployment options, see:

• Installation Instructions - Setup and configuration guide
• Docker Guide - Docker deployment methods
• What's New in v1.2 - New features and improvements
• E2EE Setup Guide - Matrix End-to-End Encryption configuration

---

Plugins

MMRelay supports plugins for extending its functionality, enabling customization and enhancement of the relay to suit specific needs.

Core Plugins

Generate a map of your nodes:

Produce high-level details about your mesh:

See the full list of core plugins.

Community & Custom Plugins

MMRelay's plugin system allows you to extend functionality in two ways:

• Custom Plugins: Create personal plugins for your own use, stored in ~/.mmrelay/plugins/custom/
• Community Plugins: Share your creations with others or use plugins developed by the community

Check the Community Plugins Development Guide in our wiki to get started.

✨️ Visit the Community Plugins List!

Install a Community Plugin

Add the repository under the community-plugins section in config.yaml:

community-plugins:
  example-plugin:
    active: true
    repository: https://github.com/jeremiah-k/mmr-plugin-template.git
    tag: main

Plugin System

Plugins make it easy to extend functionality without modifying the core program. MMRelay features a powerful plugin system with standardized locations:

• Core Plugins: Pre-installed with the package
• Custom Plugins: Your own plugins in ~/.mmrelay/plugins/custom/
• Community Plugins: Third-party plugins in ~/.mmrelay/plugins/community/

---

Getting Started with Matrix

See our Wiki page Getting Started With Matrix & MMRelay.

---

Already on Matrix?

Join us!

• Our project's room: #mmrelay:matrix.org
• Part of the Meshnet Club Matrix space: #meshnetclub:matrix.org
• Public Relay Room: #mmrelay-relay-room:matrix.org - Where we bridge multiple meshnets. Feel free to join us, with or without a relay!