Contributors Forks Stargazers Issues MIT License

nmapprom

Prometheus exporter for counting the hosts connected to a network using nmap
· Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License

About The Project

nmapprom is a Prometheus exporter for counting the hosts connected to a network using nmap, written in Go.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • nmap
  • Go

Installation

  1. Clone the repo

    git clone https://github.com/OisinA/nmapprom.git
  2. Build the go project

    go build

Usage

nmapprom requires passing in the ip range of your local network, checking to see what addresses are in use.

nmapprom -i 192.168.0.0/24

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

GitHub

https://github.com/OisinA/nmapprom