Skip to content

LAN-Orangutan is a self-hosted network discovery tool. Find every device on your LAN, label and group them, snapshot your network and compare it later, and get flagged when something unexpected shows up. Single binary, no setup, Tailscale built in. Built by 291 Group.

3.1 KB
Raw Blame

Installation Guide

Quick Install (Recommended)

Download the latest release for your platform from GitHub Releases.

Linux

# Download and extract
wget https://github.com/291-Group/LAN-Orangutan/releases/latest/download/orangutan-linux-amd64.tar.gz
tar xzf orangutan-linux-amd64.tar.gz

# Run (use sudo for MAC addresses and vendor info)
sudo ./orangutan serve

macOS

With Homebrew:

brew install 291-group/tap/lan-orangutan

Or by hand:

# Download and extract
curl -LO https://github.com/291-Group/LAN-Orangutan/releases/latest/download/orangutan-darwin-arm64.tar.gz
tar xzf orangutan-darwin-arm64.tar.gz

# Run (use sudo for MAC addresses and vendor info)
sudo ./orangutan serve

Windows

With Scoop:

scoop bucket add 291group https://github.com/291-Group/scoop-bucket
scoop install lan-orangutan

Or by hand:

Download orangutan-windows-amd64.zip from GitHub Releases, extract, and run as Administrator.

Requirements

  • nmap must be installed:
    • Linux: sudo apt install nmap or sudo dnf install nmap
    • macOS: brew install nmap
    • Windows: Download from nmap.org

Building from Source

git clone https://github.com/291-Group/LAN-Orangutan.git
cd LAN-Orangutan
go build -o orangutan ./cmd/orangutan

Running as a Service

Linux (systemd)

Create /etc/systemd/system/lan-orangutan.service:

[Unit]
Description=LAN Orangutan Network Discovery
After=network.target

[Service]
Type=simple
ExecStart=/usr/local/bin/orangutan serve
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target

Then:

sudo cp orangutan /usr/local/bin/
sudo systemctl daemon-reload
sudo systemctl enable lan-orangutan
sudo systemctl start lan-orangutan

macOS (launchd)

Create ~/Library/LaunchAgents/com.291group.lan-orangutan.plist:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>Label</key>
    <string>com.291group.lan-orangutan</string>
    <key>ProgramArguments</key>
    <array>
        <string>/usr/local/bin/orangutan</string>
        <string>serve</string>
    </array>
    <key>RunAtLoad</key>
    <true/>
    <key>KeepAlive</key>
    <true/>
</dict>
</plist>

Then:

cp orangutan /usr/local/bin/
launchctl load ~/Library/LaunchAgents/com.291group.lan-orangutan.plist

Configuration

Config file locations:

  • Linux: ~/.config/lan-orangutan/config.ini or /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.

Firewall

Allow port 291 (or your configured port):

# Linux (ufw)
sudo ufw allow 291/tcp

# Linux (firewalld)
sudo firewall-cmd --add-port=291/tcp --permanent
sudo firewall-cmd --reload

Verify Installation

orangutan version
orangutan status
curl http://localhost:291/setup