Skip to content

Running with Docker

1. Docker compose

Create a new folder and create inside it two files: compose.yaml and options.yaml. Configure the serial port and serial baud rate to fit your configuration abd run it with the follwoing command.

docker compose up -d
  • compose.yaml
services:
  meshmeshgo:
    image: ghcr.io/espmeshmesh/amd64-meshmeshgo-addon:latest
    container_name: meshmeshgo
    network_mode: host
    privileged: true
    devices:
      - /dev/ttyUSB0:/dev/ttyUSB0
    volumes:
      - ./:/data:rw
    restart: unless-stopped
  • options.json
{
    "WantHelp": false,
    "SerialPortName": "/dev/ttyUSB0",
    "SerialPortBaudRate": 115200,
    "SerialIsEsp8266": true,
    "VerboseLevel": 2,
    "TargetNode": 0,
    "DebugNodeAddr": "",
    "RestBindAddress": ":4040",
    "RpcBindAddress": "",
    "BindAddress": "dynamic",
    "BindPort": 6053,
    "BasePortOffset": 20000,
    "SizeOfPortsPool": 10000,
    "EnableZeroconf": true,
    "DataFolder": "/data/"
  }

2. Run docker image

This guide explains how to run the meshmeshgo program in Docker. The app requires access to: 1. Serial device (e.g., /dev/ttyUSB0)

2.1. Pull the prebuilt Docker Image

From the project root (where the Dockerfile is located):

docker pull ghcr.io/espmeshmesh/amd64-meshmeshgo-addon:latest

2.2 Run with docker run

NB This command will tell docker to use the current working directory as storage for persistent files like 

docker run --rm -it --network host --privileged -v $(pwd):/data/ --device /dev/ttyUSB0 amd64-meshmeshgo-addon:latest

If you need to change some config values create the an options.json file in your persistent folder and modify the corresponding value.

If there is no options.json in the persistent data folder a default one will be created. 

{
  "WantHelp": false,
  "DataFolder": "/data/",
  "SerialPortName": "/dev/ttyUSB0",
  "SerialPortBaudRate": 115200,
  "SerialIsEsp8266": false,
  "SerialShouldRetry": true,
  "SerialResetOnInit": false,
  "VerboseLevel": 0,
  "TargetNode": 0,
  "DebugNodeAddr": "",
  "RestBindAddress": ":4040",
  "RpcBindAddress": "",
  "BindAddress": "dynamic",
  "BindPort": 6053,
  "BasePortOffset": 20000,
  "SizeOfPortsPool": 10000,
  "EnableZeroconf": true
}