Skip to main content

Getting Started

First of all, thank you so much for showing interest in Mud.band. In this section, we will explain how to create a mesh network between two computers using mud.band. Mud.band is not difficult to use.

Just remember these four simple steps:

  1. Create a band.
  2. Generate an enrollment token.
  3. Install the mud.band app on both computers.
  4. Register both devices using the enrollment token.

Simple, right? Now, let's go into a bit more detail about each step.

Create a band​

To connect your devices in a mesh network, you first need to create a band. Here's how you can do it:

  1. Log in to https://www.mud.band/. If you don't have an account, create one.
  2. After logging in, go to the dashboard and click the "Create a band" link to create a band.

Generate an enrollment token​

Once you have created the band, it's time to register your devices. To do this, you'll need an enrollment token, which can be generated as follows:

  1. Visit the band you created on https://www.mud.band/.
  2. In the band menu, find the "Enrollment Token" and click the "Create" link to generate one.

Install the mud.band app on both computers​

Now, install the mud.band app on both computers you want to connect in your mesh network. Since the installation process varies by platform, please refer to the relevant documentation for detailed instructions.

In this example, we will use one Linux computer and one Windows computer to demonstrate cross-platform connectivity.

Register both devices using the enrollment token​

Once the app is installed on both computers, it's time to register your devices. The enrollment process differs slightly between Linux and Windows:

On the Linux computer:​

sudo ./mudband -e <enrollment_token_uuid> -n linux-computer

If it doesn't show any error, enrollment has been successfully completed. Now, it's time to connect your devices to the band.

sudo ./mudband

Please note that you need to run this command with sudo privilege because it requires to access the tap(4) device.

On the Windows computer:​

In this example, we assume that mud.band UI package is installed on the Windows.

  1. Open the mud.band UI from the Start menu. It'll show the enrollment screen if it could not find any enrollment information in the local storage.

  2. Enter the enrollment token and click the "Enroll" button.

  3. The device will be registered to the band.

Now, it's time to connect your devices to the band. Please click the "Connect" button on the mud.band UI.

Testing the mesh network​

To test if your mesh network is working properly, you can try pinging one computer from the other. You can get the private IP address of the computer from the mud.band UI or from the command line output.

  • From the Linux computer:

    Open the terminal and run the following command:

    ping <private_ip_address_of_the_windows_computer>

  • From the Windows computer:

    Open the Command Prompt and run the following command:

    ping <private_ip_address_of_the_linux_computer>

Congratulations! You have successfully set up a cross-platform mesh network between a Linux and a Windows computer using mud.band.