https://github.com/kljama/netscan
A tool for scanning defined network ranges and querying sysName and sysDescr
https://github.com/kljama/netscan
network-monitoring network-monitoring-tool network-scanner network-scanning
Last synced: 11 days ago
JSON representation
A tool for scanning defined network ranges and querying sysName and sysDescr
- Host: GitHub
- URL: https://github.com/kljama/netscan
- Owner: kljama
- License: mit
- Created: 2025-10-13T23:34:09.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-03-20T11:55:08.000Z (4 months ago)
- Last Synced: 2026-03-21T04:18:46.595Z (4 months ago)
- Topics: network-monitoring, network-monitoring-tool, network-scanner, network-scanning
- Language: Go
- Homepage:
- Size: 88.9 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# netscan
---
## Key Features
* **Automated Discovery**: Randomized ICMP sweeps across multiple subnets to automatically find new devices.
* **Real-Time Monitoring**
* **Optional SNMP Enrichment**
* **InfluxDB Integration**: Native support for InfluxDB v2, separating operational metrics from health telemetry.
* **Secure Deployment**: Native systemd installation supports rootless execution via capability-based security (`CAP_NET_RAW`), while Docker orchestration simplifies local evaluation.
---
## Docker Quick Start
Get up and running in minutes with the pre-configured Docker stack.
### Prerequisites
* Docker Engine 20.10+
* Docker Compose V2
### 1. Clone & Configure
```bash
git clone https://github.com/kljama/netscan.git
cd netscan
# Create config files
cp config.yml.example config.yml
cp .env.example .env
```
### 2. Set Your Network Range
Open `config.yml` and set your **actual** network CIDR.
```yaml
networks:
- "192.168.1.0/24" # <--- Change this to your network!
```
### 3. Launch
```bash
docker compose up -d
```
Access the **InfluxDB UI** at `https://localhost` (User: `admin`, Pass: `admin123`).
---
## Deployment Options
| Method | Best For | Description |
|--------|----------|-------------|
| **Docker Compose** | Testing & Small Prod | Easiest setup. Orchestrates netscan + InfluxDB together. |
| **Native Systemd** | Production Security | Runs as dedicated user with minimal capabilities. |
> See **[MANUAL.md](MANUAL.md)** for detailed deployment guides, security hardening, and configuration references.
---
## Verification
Check if the service is running correctly:
```bash
# View live logs
docker compose logs -f netscan
# Check health endpoint
curl http://localhost:8080/health
```
---
## License
MIT License - See [LICENSE.md](LICENSE.md)