From b0aa6ff9a827dbb8fc2c9ab38fe311eb49853367 Mon Sep 17 00:00:00 2001 From: Keith Solomon Date: Tue, 14 Apr 2026 08:30:57 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=84=20docs:=20Update=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 89e234d..6e9cffa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # NetTrak NetTrak is a Dockerized network inventory web app that scans a subnet and catalogs: + - Devices discovered on the network - Open ports per device - Service fingerprint details from `nmap` @@ -29,17 +30,28 @@ Results are persisted in SQLite for change tracking (new/updated/missing devices ## Run With Docker Compose +Use the provided `docker-compose.yml` to run the app: + ```bash -docker compose up --build +docker compose up -d ``` Then open: `http://localhost:1337` Database file is stored at `./data/nettrak.db` via a bind mount. +## For a fresh build (for example to change the internal port) + +```bash +git clone https://git.keithsolomon.net/keith/NetTrak +cd NetTrak +docker compose -f docker-compose-build.yml up --build +``` + ## Configuration Environment variables: + - `NETTRAK_DB_PATH` (default: `/data/nettrak.db`) - `NETTRAK_SUBNET` (default: `192.168.2.0/24`) - `NETTRAK_TOP_PORTS` (default: `100`) @@ -69,6 +81,7 @@ network_mode: host NetTrak can optionally annotate host ports that are published by Docker containers on the scan host. To enable: + - set `NETTRAK_ENABLE_DOCKER_INSIGHTS=1` - mount the Docker socket: