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 Docker

Latest release:

Stable RC Beta

Health:

pytest packaging pylint


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 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

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)

Note: Network scanning requires --network host mode for ARP/device discovery. Without it, you won't see MAC addresses/hostnames

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.0b1.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.0b1-py3-none-any.whl (2.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lanscape-3.3.0b1.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.0b1.tar.gz
Algorithm Hash digest
SHA256 2ece82bc8950a23cbc0f288294a9bf86cb088d1c04baed51ef92956e64f028ac
MD5 9a413cb622eb1121ea56f60d2f180594
BLAKE2b-256 4406a52a484add49d721e38cec39ca72b4a99366caa239ac3327d0e8c0aeb56b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lanscape-3.3.0b1-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.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 f38510d6ef23318bce96fe343cee047e9eefbb230b2ca7b0ab9b5521394277fc
MD5 16e21a9c45f5c96c85a76111ea4506db
BLAKE2b-256 43863c24ba4a4df43fc4790526036b8e06b9bdcdefeec9b5f1de588db47f571b

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