Skip to main content

A python based local network scanner

Project description

LANscape

A local network scanner with a built-in web UI. Discover devices, open ports, and running services on your network.

The UI was recently converted into react, stored in a separate repo: mdennis281/lanscape-ui

pip install lanscape
python -m lanscape

Stats:

Version Monthly Downloads

Latest release:

Stable RC Beta

Docker:

lanscape lanscape-arm

Health:

pytest pylint packaging docker


LANscape UI

More screenshots

Scan Configuration

Port Detail


Flags

Flag Description
--version Show the installed version and exit
--ui-port <number> Port for the web UI (default: auto)
--ws-port <number> Port for the WebSocket server (default: 8766)
--ws-server Start WebSocket server only (no UI)
--persistent Don't auto-shutdown when the browser tab closes
--mdns-off Disable mDNS service discovery
--logfile <path> Write log output to a file
--loglevel <level> Set log level: DEBUG, INFO, WARNING, ERROR, CRITICAL (default: INFO)
--debug Shorthand for --loglevel DEBUG
python -m lanscape
python -m lanscape --version
python -m lanscape --ui-port 8080
python -m lanscape --debug --persistent
python -m lanscape --logfile /tmp/lanscape.log --loglevel WARNING
python -m lanscape --ws-server --ws-port 9000

Docker (Linux Only)

Docker is recommended for Linux hosts only. Network scanning requires --network host mode, which only works properly on Linux. For Windows/Mac, use pip install lanscape instead.

Images

Architecture Image Platforms
AMD64 (x86_64) ghcr.io/mdennis281/lanscape:latest Most servers, desktops
ARM64 (aarch64) ghcr.io/mdennis281/lanscape-arm:latest Raspberry Pi, Apple Silicon, AWS Graviton

Quick Start

AMD64:

docker run -d --name lanscape \
  --network host \
  --cap-add NET_RAW \
  --cap-add NET_ADMIN \
  ghcr.io/mdennis281/lanscape:latest

ARM64:

docker run -d --name lanscape \
  --network host \
  --cap-add NET_RAW \
  --cap-add NET_ADMIN \
  ghcr.io/mdennis281/lanscape-arm:latest

Or use Docker Compose:

curl -O https://raw.githubusercontent.com/mdennis281/LANscape/main/docker/docker-compose.yml
docker compose up -d                              # AMD64 (default)
docker compose --profile arm64 up -d lanscape-arm # ARM64

Access the UI at http://localhost:5001

Custom Ports

To use different ports, set the environment variables. When using --network host (as below), Docker ignores -p, so only the environment variables are needed. In bridge mode, you must also publish the matching ports with -p/ports:.

docker run -d --name lanscape \
  --network host \
  -e LANSCAPE_UI_PORT=8080 \
  -e LANSCAPE_WS_PORT=8081 \
  --cap-add NET_RAW \
  --cap-add NET_ADMIN \
  ghcr.io/mdennis281/lanscape:latest

Required Ports

LANscape uses two ports that must be reachable for the UI and live scan updates to work:

Port Purpose
5001 Web UI (HTTP)
8766 WebSocket (live scan data)

With --network host (Linux), both ports are automatically available on the host — no extra flags needed.

In bridge mode (or Docker Desktop on Windows/Mac), you must publish them explicitly:

docker run -d --name lanscape \
  -p 5001:5001 \
  -p 8766:8766 \
  --cap-add NET_RAW \
  --cap-add NET_ADMIN \
  ghcr.io/mdennis281/lanscape:latest

Note: Bridge mode limits scanning to TCP port probing only — ARP/ICMP device discovery requires --network host on Linux.

Environment Variables

Variable Default Description
LANSCAPE_UI_PORT 5001 Web UI port
LANSCAPE_WS_PORT 8766 WebSocket server port
LANSCAPE_LOG_LEVEL INFO Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
LANSCAPE_MDNS true Enable mDNS discovery (true/false)
LANSCAPE_WS_ONLY false WebSocket-only mode (true/false)
LANSCAPE_LOG_FILE None Path to log file (optional)

If you change LANSCAPE_UI_PORT or LANSCAPE_WS_PORT, update your -p mappings (bridge mode) or firewall rules accordingly.

Troubleshooting

MAC Address / Manufacturer is inaccurate or unknown

LANscape does an ARP lookup to determine MAC addresses. This can require elevated permissions to get accurate results — try running your shell as admin.

Scan accuracy seems low

The scanner uses a combination of ARP, ICMP, and port probing to find devices. If results aren't great out of the box:

  • Tweak the scan configuration preset (accessible from the gear icon)
  • Set up ARP lookup properly — see ARP issues
  • Open an issue if something still seems off

Something else

Feel free to submit an issue with details about what you're seeing.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lanscape-3.3.0rc1.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lanscape-3.3.0rc1-py3-none-any.whl (2.1 MB view details)

Uploaded Python 3

File details

Details for the file lanscape-3.3.0rc1.tar.gz.

File metadata

  • Download URL: lanscape-3.3.0rc1.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for lanscape-3.3.0rc1.tar.gz
Algorithm Hash digest
SHA256 5b1ac90754ff8293cad596b713b6f91c5daa16dc47f677f298ef5d91d29c9d9f
MD5 d19920d3d3e4ca47c20a917ec4516879
BLAKE2b-256 d8b7ebf7aafdb124026d76c97ce127e6689c606238e4e97ce1b35ed3e9a90377

See more details on using hashes here.

File details

Details for the file lanscape-3.3.0rc1-py3-none-any.whl.

File metadata

  • Download URL: lanscape-3.3.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for lanscape-3.3.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe59b550568ba35097ad288350dadab322d170f868d6c07eee5dba7661e30912
MD5 f9fcccd1d9896464bbaad20e27eb1255
BLAKE2b-256 0330e535de225ba7d435ef6818d7f09b54dd55a574fa3edc5f17f25e37b98792

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page