NetTool

NetTool

[!IMPORTANT] NetTool is a personal, educational project. It is not hardened for production environments and several plugins expect trusted networks or elevated privileges. Review each plugin before using it in critical scenarios.

NetTool is a web-based network diagnostic console for Raspberry Pi and other Linux devices. It centralizes common troubleshooting utilities, live telemetry, and a plugin marketplace into a single responsive dashboard.

Documentation is maintained with the help of AI tooling. If you spot an omission or error, please open an issue or pull request.

Table of Contents

• Highlights
• Architecture Overview
• Prerequisites
• Quick Start
• Running & Deployment
• Configuration
• Dashboard at a Glance
• Plugin Ecosystem
• API & Realtime Access
• Troubleshooting
• Development Workflow
• Project Status
• License
• Open Source Credits
• Acknowledgments

Highlights

• Unified dashboard with real-time interface statistics, DHCP lease state, traffic counters, and connection health.
• Modular plugin framework supporting native Go plugins and external scripts (Python/Bash) with dynamic discovery.
• Rich diagnostics catalog including bandwidth tests, latency heatmaps, packet capture, iPerf3, traceroute, DNS utilities, SSL checks, and more.
• REST & WebSocket APIs for automation, remote orchestration, and live telemetry streaming.
• Mobile-first UI built with Bootstrap and Chart.js so the console works on tablets and phones beside your rack.
• Service-friendly packaging featuring systemd examples, install scripts, and optional external tool integrations.

Architecture Overview

• Backend: Go 1.24+, Gin web framework, Gorilla WebSocket, gopsutil for system interrogation.
• Frontend: Bootstrap 5, Bootstrap Icons, Chart.js, vanilla JS modules for real-time updates.
• Plugins: Organized under app/plugins/plugins/<plugin_id>, each with metadata (plugin.json) and an Execute entrypoint.
• Storage: Configuration and plugin assets served from the local filesystem; no database dependency.

Prerequisites

• Raspberry Pi (Zero 2W, 3B+, 4) or any Linux host.
• Go toolchain 1.20+, tested on 1.24.4.
• GitHub CLI (gh) for plugin install automation.
• Optional third-party CLIs based on your plugin selection: librespeed-cli, iperf3, nmap, tcpdump, etc.

Quick Start

git clone https://github.com/NetScout-Go/NetTool.git
cd NetTool

# Install core dependencies
sudo apt update
sudo apt install gh librespeed-cli
gh auth login

# Fetch plugins (select interactively)
chmod +x install-plugins.sh
./install-plugins.sh

# Build & run
go build
./nettool --port 8080

Pi Zero tip: Use env CGO_ENABLED=0 go build if you hit CGO-related link errors.

Visit http://<device-ip>:8080 to open the dashboard.

Running & Deployment

• Foreground: ./nettool --port 8080

• Elevated plugins: sudo ./nettool for features requiring privileged sockets or traffic shaping.

• systemd service:

  [Unit]
  Description=NetTool Network Diagnostic Tool
  After=network.target
  
  [Service]
  ExecStart=/home/pi/NetTool/nettool --port 8080
  WorkingDirectory=/home/pi/NetTool
  Restart=always
  User=pi
  
  [Install]
  WantedBy=multi-user.target
  

  sudo systemctl enable netscout.service
  sudo systemctl start netscout.service
  sudo systemctl status netscout.service
  

Configuration

nettool accepts flags and an optional config.json in the project root:

{
  "port": 8888,
  "debug": true,
  "allowCORS": false,
  "refreshInterval": 5
}

Flags override file values. Restart the service after editing the config.

Dashboard at a Glance

• Connection status with uptime, link speed, duplex mode, and interface health.
• IP configuration showing IPv4/IPv6 addresses, gateways, DNS servers, and DHCP lease metrics.
• Traffic statistics updating live via WebSocket (packets, bytes, errors).
• Network topology hints including ARP snapshots and discovered devices.
• Speed test card backed by librespeed-cli (preferred) with fallbacks to other CLIs or simulated results.

Plugin Ecosystem

• Plugins live under app/plugins/plugins/ and are categorized (Analysis, Discovery, DNS, Security, etc.).
• Each plugin exposes metadata via plugin.json and a Go Execute function or external script wrapper.
• Manage plugins with helper scripts:
  • ./install-plugins.sh – clone/update official plugin repositories.
  • ./list-plugins.sh – enumerate installed plugins the UI will surface.
• Refer to app/plugins/DEVELOPMENT.md for authoring guidelines (parameters, result contracts, logging).

Spotlight Plugins

API & Realtime Access

• List plugins: GET /api/plugins
• Plugin metadata: GET /api/plugins/{id}
• Run plugin: POST /api/plugins/{id}/run with JSON payload
• Network snapshot: GET /api/network-info

Example (ping):

curl -X POST http://<device-ip>:8080/api/plugins/ping/run \
  -H "Content-Type: application/json" \
  -d '{"host": "example.com", "count": 4}'

WebSocket Stream

const ws = new WebSocket('ws://<device-ip>:8080/ws');
ws.onmessage = event => console.log(JSON.parse(event.data));

Messages include traffic counters, interface state changes, DHCP lease updates, and plugin progress events.

Troubleshooting

• Compilation errors (Pi Zero): env CGO_ENABLED=0 go build
• Permission errors: Run with sudo if the plugin needs raw sockets or tc access.
• Missing tool: Install the CLI noted in the plugin card or disable the plugin in config.
• WebSocket blocked: Check firewalls or reverse proxies that strip upgrade headers.
• Logs: journalctl -u netscout.service -f

Development Workflow

• Format code: gofmt -w .
• Lint (optional): integrate golangci-lint or staticcheck locally.
• Run tests: go test ./...
• Hot reload (dev): use CompileDaemon or air if preferred.
• Contribution steps:
  1. Fork the repo
  2. git checkout -b feature/<name>
  3. Commit with clear messages
  4. git push origin feature/<name>
  5. Open a Pull Request describing changes and testing

Project Status

• Focused on hobbyist and hackathon deployments.
• Known rough edges: limited authentication, plugin permission model, i18n gaps.
• Roadmap ideas: role-based access, plugin marketplace UI enhancements, telemetry export.

License

This project ships under the MIT License. See LICENSE for full text.

Open Source Credits

NetTool exists thanks to these excellent projects:

• Go
• Gin and gin-contrib/multitemplate
• gopsutil
• gorilla/websocket
• Bootstrap, Bootstrap Icons, and Chart.js
• LibreSpeed CLI and speedtest-cli
• iperf3, nmap, and tcpdump

Acknowledgments

• The Go community for stellar networking libraries and tooling
• Raspberry Pi Foundation for repeatedly punching above its weight
• All contributors, testers, and Hack Club members cheering this project on