Das Repository docker-mmrelay bietet dir eine flexible und einfache Methode, ein Proxy-Relay mit Docker zu betreiben. In diesem Beitrag zeige ich dir, wie du das Projekt einrichtest und verwendest.

Meshtastic-Matrix-Relay mit Docker

Dieses Repository bietet dir eine Docker-basierte Einrichtung für die Ausführung des Meshtastic-Matrix-Relays, welches Nachrichten zwischen Matrix- und Meshtastic-Netzwerken weiterleitet.

Voraussetzungen

• Docker und Docker Compose installiert
• Ein Matrix-Homeserver mit:
  • Homeserver-URL
  • Zugriffstoken
  • Bot-Benutzer-ID
• Ein konfiguriertes und zugängliches Meshtastic-Gerät oder -Netzwerk

Erste Schritte

Schritt 1: Repository klonen

Klon das Repository auf deinen lokalen Rechner:

git clone https://github.com/mcules/docker-mmrelay.git
cd docker-mmrelay

Schritt 2: Matrix-Bot registrieren

Folge der T2Bot Access Token Anleitung, um:

1. Ein Bot-Konto auf deinem Matrix-Homeserver zu registrieren.
2. Das Zugriffstoken für den Bot zu erhalten.
3. Die Benutzer-ID und das Zugriffstoken des Bots für die spätere Konfiguration zu notieren.

Schritt 3: Beispielkonfiguration erhalten

Lade die Beispielkonfigurationsdatei herunter und speichere sie als data/config.yaml im Stammverzeichnis des Repositorys:

wget https://github.com/geoffwhittington/meshtastic-matrix-relay/blob/main/sample_config.yaml -O data/config.yaml

Bearbeite die Datei data/config.yaml, um sie an deine Umgebung anzupassen. Hier ein Überblick über die wichtigsten Abschnitte:

Matrix-Konfiguration

matrix:
  homeserver: https://matrix.domain.tld
  access_token: YOUR_ACCESS_TOKEN
  bot_user_id: "@meshtastic_bot:matrix.domain.tld"

• Ersetze https://matrix.domain.tld durch die URL deines Matrix-Homeservers.
• Füge das Zugriffstoken und die Benutzer-ID deines Bots hinzu.

Matrix-Räume

matrix_rooms:
  meshtastic_channel: 2
  - id: "#meshtastic@myChannel:matrix.domain.tld"

• Definiere die Matrix-Räume, um Nachrichten zu/von Meshtastic-Kanälen weiterzuleiten.

Meshtastic-Konfiguration

meshtastic:
  connection_type: network
  host: 192.168.1.2
  broadcast_enabled: true
  detection_sensor: true
  plugin_response_delay: 3
  relay_reactions: true

• Setze connection_type auf network, serial oder ble basierend auf deiner Einrichtung.
• Konfiguriere host oder andere Parameter (z. B. serial_port oder ble_address) nach Bedarf.

Schritt 4: Anwendung starten

Starte den Container mit Docker Compose:

docker-compose up -d

Schritt 5: Einrichtung überprüfen

Prüfe die Protokolle, um sicherzustellen, dass die Anwendung korrekt läuft:

docker logs meshtastic-relay

Konfigurationsänderungen

Vergleiche deine Konfiguration mit der Beispielkonfigurationsdatei. Hier sind die wichtigsten Unterschiede:

• Matrix:
  • Füge die Homeserver-URL, das Zugriffstoken und die Bot-Benutzer-ID hinzu.
• Matrix-Räume:
  • Definiere einen Raum mit einem spezifischen Meshtastic-Kanal.
• Meshtastic:
  • Stelle die Verbindung auf network mit einer definierten Host-IP ein.
  • Aktiviere Broadcasting, Sensordetektion und Reaktionsweiterleitungen.

Zusätzliche Informationen

• Für weitere Details zur Meshtastic-Matrix-Relay-Anwendung sieh dir das Original-Repository an.
• Um den Container zu stoppen:

docker-compose down

• Um die Anwendung zu aktualisieren:

docker-compose pull
docker-compose up -d

Bei Problemen oder wenn du beitragen möchtest, kannst du gerne ein Issue erstellen oder einen Pull-Request einreichen.

Bitte beachten
Die spezifischen Werte wie YOUR_ACCESS_TOKEN und @meshtastic_bot:matrix.domain.tld musst du durch deine tatsächlichen Daten ersetzen.