Getting Started - MapTheMesh

To get started, you first need an API Token.

Once you have your API Token, you can add your Meshtastic nodes to the platform.
To do this, you will need to use the client script, located here...

This client script can be ran manually, or setup as a cron job to run every 15 minutes (recommended minimum).

NOTE: If you do not want to send over your config, then you can add the following environeent variable to the client script:

MESHTASTIC_NO_INFO=true

This will prevent the client script from sending over your config to the platform. More information here.

If you are using Linux, there is an install script. available to help you get started.

wget -q -O - https://script.themesh.live/install.sh | bash

→ Once installed, you will need to edit the downloaded script to add your “API_KEY”.

nano ${HOME}/.config/mapthemesh/mapthemesh-runner

→ Now installed, the script is setup as a cron job to run every 15 minutes (recommended minimum).

→ By default its setup to connect to a USB connected Meshtastic device. With the Network fallback, as per the Meshtastic CLI documentation.

You can also use the docker image to run the client script.

→ Let the Meshtastic CLI find the node itself (This will most likely fail!);

docker run -d \
    --privileged \
    --name MeshtasticNodeTransmitClient \
    -e API_KEY='INSERT-YOUR-API-TOKEN' \
    ghcr.io/mapthemesh/runner:latest

→ Connect the Meshtastic CLI to a specified USB port;

docker run -d \
    --privileged \
    --name MeshtasticNodeTransmitClient \
    -e API_KEY='INSERT-YOUR-API-TOKEN' \
    -e MESHTASTIC_PORT='INSERT-YOUR-NODE-PORT' \
    ghcr.io/mapthemesh/runner:latest

→ Connect the Meshtastic CLI to a specified HTTP Host;

docker run -d \
    --name MeshtasticNodeTransmitClient \
    -e API_KEY='INSERT-YOUR-API-TOKEN' \
    -e MESHTASTIC_HOST='INSERT-YOUR-NODE-IP' \
    ghcr.io/mapthemesh/runner:latest

→ Connect the Meshtastic CLI to a specified Bluetooth MAC Address;

docker run -d \
    --privileged \
    --name MeshtasticNodeTransmitClient \
    -e API_KEY='INSERT-YOUR-API-TOKEN' \
    -e MESHTASTIC_BLE='INSERT-YOUR-NODE-BLUETOOTH-MAC' \
    ghcr.io/mapthemesh/runner:latest

For the Docker container to access your node over Bluetooth or USB Serial, you will need to share the Bluetooth/USB device with the container.
This has been done by adding the “--privileged” flag to the “docker run” command.

This is not recommended for production environments.