📄 docs: Update readme

This commit is contained in:
Keith Solomon
2026-04-14 08:30:57 -05:00
parent d246267c9d
commit b0aa6ff9a8
+14 -1
View File
@@ -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: