pepr90210/ubnt-discovery-cli repository overview

⁠UBNT Discovery Tool CLI - Docker Image

A lightweight Docker container for the UBNT Discovery Tool CLI - Network discovery tool for Ubiquiti devices. This containerized version provides an easy way to scan for Ubiquiti devices on your network without installing dependencies on your host system.

⁠Features

• Network Device Discovery: Automatically discovers Ubiquiti devices on your network
• CLI Interface: Command-line interface for scripting and automation
• Host Network Support: Uses host networking for optimal device discovery
• Lightweight: Based on Alpine Linux with OpenJDK 13
• Cross-Platform: Runs on any system supporting Docker

⁠Quick Start

⁠Basic Usage

# Show help
docker run --rm --network=host pepr90210/ubnt-discovery-cli:latest

# Scan for devices (5 seconds)
docker run --rm --network=host pepr90210/ubnt-discovery-cli:latest -sec 5

# Scan with grouped output
docker run --rm --network=host pepr90210/ubnt-discovery-cli:latest -sec 10 -grouped

⁠Advanced Usage

# Scan specific network interface
docker run --rm --network=host pepr90210/ubnt-discovery-cli:latest -interface eth0 -sec 10

# Extended scan with custom ratio
docker run --rm --network=host pepr90210/ubnt-discovery-cli:latest -sec 30 -ratio 50

# Save results to file
docker run --rm --network=host pepr90210/ubnt-discovery-cli:latest -sec 10 > ubnt-devices.txt

⁠Command Line Options

⁠Network Requirements

• Host Network: The container must use --network=host to properly discover devices on your local network
• UDP Port 10001: The discovery protocol uses UDP port 10001 for communication
• Multicast Support: Your network must support multicast/broadcast packets

⁠Examples

⁠Home Network Scan

# Quick 5-second scan of your home network
docker run --rm --network=host pepr90210/ubnt-discovery-cli:latest -sec 5

⁠Continuous Monitoring

# Long-running scan for monitoring
docker run --rm --network=host pepr90210/ubnt-discovery-cli:latest -sec 300

⁠Specific Interface

# Scan only through specific interface
docker run --rm --network=host pepr90210/ubnt-discovery-cli:latest -interface wlan0 -sec 10

⁠Expected Output

The tool will display discovered devices in the following format:

============ 'airCube AC' v0x001@wlan0 ============
   HW_ADDRESS (0x1): 224.99.218.76
       IPINFO (0x2): IpInfo{mac='E0:63:DA:4D:8D:42', ip='192.168.1.100'}
   FW_VERSION (0x3): ACB.ar934x.v2.8.9.63297e8f6e.230619.1229
       UPTIME (0xa): 15519
     HOSTNAME (0xb): airCube-AC-Office
     PLATFORM (0xc): ACB-AC
        MODEL (0x14): airCube AC
     LOCATING (0x18): false

⁠Troubleshooting

⁠No Devices Found

• Ensure you're using --network=host
• Verify your network supports multicast/broadcast
• Check firewall settings (UDP port 10001)
• Try increasing scan time with -sec 30

⁠Permission Issues

• Some networks may require elevated privileges
• Try running with --privileged flag if needed

⁠Network Interface Issues

• List available interfaces: docker run --rm --network=host alpine ip link show
• Specify interface explicitly with -interface <name>

⁠Docker Compose

version: '3.8'
services:
  ubnt-discovery:
    image: pepr90210/ubnt-discovery-cli:latest
    network_mode: host
    command: ["-sec", "10", "-grouped"]
    restart: "no"

⁠Building from Source

git clone https://github.com/MatrixEditor/ubnt-discovery-tool.git
cd ubnt-discovery-tool
docker build -t ubnt-discovery-cli .

⁠Support

• Original Project: UBNT Discovery Tool⁠
• Docker Hub: pepr90210/ubnt-discovery-cli⁠
• Issues: Report issues on the original GitHub repository

⁠License

This project follows the same license as the original UBNT Discovery Tool. See the original repository for license details.

⁠Tags

• latest - Latest stable version
• 1.3.3 - Specific version tag
• Additional semantic version tags available

Note: This tool is designed for network discovery and management purposes. Always ensure you have permission to scan networks you don't own.