mirror of
https://github.com/291-Group/LAN-Orangutan.git
synced 2026-04-27 02:16:01 +03:00
LAN Orangutan is a lightweight network scanner with persistent device labeling, multi-network support, and Tailscale integration. Built by 291 Group.
| .github/workflows | ||
| cli | ||
| cmd/orangutan | ||
| docs | ||
| internal | ||
| scanner | ||
| scripts | ||
| snap | ||
| systemd | ||
| web | ||
| .gitignore | ||
| config.example.ini | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| install.sh | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| uninstall.sh | ||
🦧 LAN Orangutan
Self-hosted network discovery for homelabbers.
Scan your networks, discover devices, label and track them - all from a clean web UI or CLI.
By 291 Group
Features
- 🔍 Auto-discover devices using nmap
- 🏷️ Label, group, and add notes to devices
- 🌐 Multi-network support
- 🔗 Tailscale integration
- 💻 Modern web dashboard with light/dark mode
- ⌨️ Full CLI with JSON output
- 🍎 Cross-platform (Linux, macOS, Windows)
- 📦 Single binary, no dependencies
Quick Start
Download
Grab the latest release of LAN Orangutan for your platform from GitHub Releases.
Run
# Linux/macOS - Run with sudo for full device info (MAC addresses, vendors)
sudo ./orangutan serve
# Windows (run as Administrator for full device info)
orangutan.exe serve
Open http://localhost:291 in your browser.
Requirements
- nmap must be installed:
- macOS:
brew install nmap - Ubuntu/Debian:
sudo apt install nmap - Windows: Download from nmap.org
- macOS:
CLI Usage
# Scan network (use sudo for MAC addresses and vendor info)
sudo orangutan scan # Scan default network
sudo orangutan scan 192.168.1.0/24 # Scan specific network
sudo orangutan scan all # Scan all detected networks
# Start web server
sudo orangutan serve # Default port 291
sudo orangutan serve --port 8080 # Custom port
# List devices
orangutan list # List all devices
orangutan list --online # List online devices only
orangutan list --format json # JSON output
# Export
orangutan export devices.csv # Export to CSV
# Check status
orangutan status # Show system status
orangutan version # Show version info
Why sudo?
Running with sudo (or as Administrator on Windows) allows nmap to:
- Read the ARP table to get MAC addresses
- Look up device vendors from MAC addresses
- Get more accurate hostname resolution
Without elevated privileges, you'll still see device IPs but MAC addresses and vendors will be missing.
Web Dashboard
The web dashboard provides:
- Real-time device status (online/offline)
- Device grouping (Server, Desktop, Laptop, Mobile, IoT, etc.)
- Labels and notes for each device
- Search and filter devices
- Export to CSV/JSON
- Auto-refresh option
- Keyboard shortcuts (/ to search, R to refresh, T to toggle theme)
Configuration
Config file location:
- Linux:
~/.config/lan-orangutan/config.inior/etc/lan-orangutan/config.ini(as root) - macOS:
~/Library/Application Support/lan-orangutan/config.ini - Windows:
%APPDATA%\lan-orangutan\config.ini
See config.example.ini for available options.
Building from Source
git clone https://github.com/291-Group/LAN-Orangutan.git
cd LAN-Orangutan
go build -o orangutan ./cmd/orangutan
License
MIT License
Built with ❤️ by 291 Group