Skip to main content

Single Binary

In this section, it'll explain how to use Mud.band in Linux environment.

Download​

For linux, there's two types of distribution; single binary and UI package. This section explains about the single binary distributeion.

You can find a package for Linux at https://www.mud.band/download link. We provides the following architectures:

  • x86_64 (64 bits)
info

The package is a tar.gz file and it looks like as follows:

  • mudband-<version>-linux-x86_64-musl.tar.gz

Installation​

At this point, a package only includes a single binary. You can install it at anywhere you want.

$ tar xvzf <package_name>

Usage​

Please use -h option to show options available.

$ ./mudband -h
Usage: ./mudband [options]
    --acl-add <syntax>           # Add an ACL rule.
    --acl-default-policy allow|block # Change the default ACL policy.
    --acl-del <acl_id>           # Delete an ACL rule.
    --acl-priority <priority>    # Specify the priority of an ACL rule.
    --acl-list                   # Get the ACL list.
    -b <uuid>                    # Specify the band UUID to use.
       --band-uuid <uuid>       
    -D, --daemon                 # Run in background
    -e <token>                   # Enroll with the given token.
       --enroll-token <token>   
    --enroll-list                # List the enrollments in the disk.
    --enroll-secret <secret>     # Set the secret for the enrollment.
    -h, --help                   # Print this message and exit.
    -n <device_name>             # Specify the device name.
       --device-name <device_name>
    -P <pid_path>                # Specify the PID file path.
       --pid <pid_path>         
    -S, --syslog                 # Log to the syslog.
    -v                           # Print the version.
    -W, --webcli                 # Get a URL to access WebCLI.

Details of each options are:

  • --acl-add <syntax>

    This command could be used if you want to add ACL rule for the device. If the band is Private type, it's not allowed to add because Band admin can control ACL.

    For details of <syntax>, please check https://www.tcpdump.org/manpages/pcap-filter.7.html man page for rules.

  • --acl-default-policy allow|block

    This option can be used to change the default policy. The value should be one of allow or block.

  • --acl-del <acl_id>

    This command could be used to delete ACL. To get the ACL ID, please use --acl-list option.

  • --acl-list

    This command could be used to list all ACL rules.

  • -b <uuid>

    Mud.band supports multiple enrollments. If you want to specify one of them, you can use this option.

  • -e <token> or --enroll-token <token>

    You can use this option to set the enrollment token. This command is used to enroll the device.

  • --enroll-secret <secret>

    Set the secret for the enrollment. This option mostly used if MFA (Multi Factor Authentication) feature is enabled.

  • -n <device_name> or --device-name <device_name>

    You can use this option to specify the device name.

  • -S

    When this option specified, the log output will go to the syslog.

  • -v

    Print the mud.band version.

  • -W or --webcli

    If you want to control the device configuration, you can do it via the web CLI.

    If the band type is the private, you can't control the device so it's not allowed to access.

Enroll​

If you want to enroll in a band, you can use -e and -n options as follows:

info

Please be aware that it requires sudo because the enroll result should go under /root/.config/mudband directory. To create a tun(4) network interface, it requires root permission to run.

$ sudo ./mudband -e <token> -n <device_name>

Run​

The folloing command is enough to run.

sudo ./mudband