m-node

README

mmesh-node

This repository contains the mmesh-node agent.

Minimun Requirements

mmesh-node has the same minimum requirements as Go:

• Linux kernel version 2.6.23 or later
• Windows 7 or later
• FreeBSD 11.2 or later
• MacOS 10.11 El Capitan or later

Installation

View the changelog for the latest updates and changes by version.

Binary Downloads

Linux, macOS and Windows binary downloads are available from the mmesh downloads page or from each GitHub Releases page.

Download the pre-compiled binaries and install them with the appropriate tools.

Package Repository

mmesh also provides a package repo that contains both DEB and RPM downloads.

For DEB-based platforms (e.g. Ubuntu and Debian) run the following to setup a new APT sources.list entry and install mmesh-node:

echo 'deb [trusted=yes] https://repo.mmesh.io/apt/ /' | sudo tee /etc/apt/sources.list.d/mmesh.list
sudo apt update
sudo apt install mmesh-node

For RPM-based platforms (e.g. RHEL, CentOS) use the following to create a repo file and install mmesh-node:

cat <<EOF | sudo tee /etc/yum.repos.d/mmesh.repo
[influxdata]
name=mmesh Repository - Stable
baseurl=https://repo.mmesh.io/yum
enabled=1
gpgcheck=0
EOF
sudo yum install mmesh-node

Artifacts Verification

Binaries

All artifacts are checksummed and the checksum file is signed with cosign.

1. Download the files you want, and the checksums.txt, checksum.txt.pem and checksums.txt.sig files from the releases page:

   wget https://github.com/mmesh/m-node/releases/download/v0.1.0/checksums.txt
   wget https://github.com/mmesh/m-node/releases/download/v0.1.0/checksums.txt.sig
   wget https://github.com/mmesh/m-node/releases/download/v0.1.0/checksums.txt.pem
   

2. Verify the signature:

   cosign verify-blob \
       --cert checksums.txt.pem \
       --signature checksums.txt.sig \
       checksums.txt
   

3. If the signature is valid, you can then verify the SHA256 sums match with the downloaded binary:

   sha256sum --ignore-missing -c checksums.txt
   

Docker Images

Our Docker images are signed with cosign.

Verify the signatures:

COSIGN_EXPERIMENTAL=1 cosign verify mmeshdev/mmesh-node

Getting Started

The easiest way to add nodes to your mmesh is by generating a magic link in the mmesh web UI or with mmeshctl:

mmeshctl node add

You will be able to use the magic link to install the mmesh-node agent in seconds with no additional configuration required.

Once installed you can review the configuration at /etc/mmesh/mmesh-node.yml.

Running with Docker

You can also run the mmesh-node agent as a Docker container. See examples below.

Registries:

• mmeshdev/mmesh-node
• ghcr.io/mmesh/mmesh-node

Example usage:

docker run -d --restart=always \
  --net=host \
  --cap-add=net_admin \
  --device=/dev/net/tun \
  --name mmesh-node \
  -v /etc/mmesh:/etc/mmesh:ro \
  mmeshdev/mmesh-node:latest start

Documentation

Documentation site: https://mmesh.io/docs

Community

Have questions, need support and or just want to talk about mmesh?

Get in touch with the mmesh community!