From 5b20d4fd75376453fd85a2277b00d20aff36384e Mon Sep 17 00:00:00 2001 From: Pouzor Date: Sat, 27 Jun 2026 02:05:40 +0200 Subject: [PATCH] docs: document SCANNER_HTTP_RANGES port-spec format Closes #229 --- .env.example | 3 +++ README.md | 14 ++++++++++++++ 2 files changed, 17 insertions(+) diff --git a/.env.example b/.env.example index 1f2b9b9..dce219f 100644 --- a/.env.example +++ b/.env.example @@ -16,6 +16,9 @@ SCANNER_RANGES=["192.168.1.0/24"] # Deep scan (optional) — extra nmap port ranges + HTTP probe for service ID on # custom ports. Defaults below are overridable per-scan from the scan dialog. +# SCANNER_HTTP_RANGES: JSON array of port specs, each a single port "N" or an +# inclusive range "N-M" (1–65535, N <= M). Not CIDRs, not bare ints. +# Example: SCANNER_HTTP_RANGES=["8080","9000-9100"] SCANNER_HTTP_RANGES=[] SCANNER_HTTP_PROBE_ENABLED=false SCANNER_HTTP_VERIFY_TLS=false diff --git a/README.md b/README.md index 553b632..8d12b51 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,20 @@ The scanner runs `nmap -sV --open` on your configured CIDR ranges and populates To save you time when mapping your infrastructure, Homlable can scan your network and report all the services it detects. It can also identify them, saving you even more time. Click **Scan Network** in the sidebar. The Scan History tab opens automatically and refreshes every 3 seconds until the scan completes. +### Deep scan (custom ports) + +By default the scanner only probes nmap's standard port set. To fingerprint services on non-standard ports, enable the deep scan via `.env` (all options are overridable per-scan from the scan dialog): + +```env +# JSON array of port specs — each entry is a single port "N" or an inclusive +# range "N-M" (1–65535, N <= M). These are ports, not CIDRs or bare integers. +SCANNER_HTTP_RANGES=["8080","9000-9100"] +SCANNER_HTTP_PROBE_ENABLED=true # send an HTTP probe to those ports for service ID +SCANNER_HTTP_VERIFY_TLS=false # verify TLS certs on the HTTP probe +``` + +The listed ports are appended to nmap's `-p` spec. Invalid entries (out-of-range, malformed, or reversed ranges) are silently skipped. + ### macOS / root privileges Some nmap scan types (SYN scan, OS detection) require root. If the scan fails with a permissions error, run it manually with sudo using the included script: