https://github.com/royrusso/probus

A FAST network scanner that identifies security vulnerabilities in your network and alerts you to new ones as they arise.
https://github.com/royrusso/probus

network-analysis network-scanner nmap nmap-scanning nmap-ui os-identifier port-scanner service-discovery vulnerability-detection vulnerability-scanners

Last synced: 3 months ago
JSON representation

A FAST network scanner that identifies security vulnerabilities in your network and alerts you to new ones as they arise.

• Host: GitHub
• URL: https://github.com/royrusso/probus
• Owner: royrusso
• License: apache-2.0
• Created: 2024-10-25T02:30:37.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-12-27T22:17:28.000Z (7 months ago)
• Last Synced: 2025-03-27T05:35:07.488Z (4 months ago)
• Topics: network-analysis, network-scanner, nmap, nmap-scanning, nmap-ui, os-identifier, port-scanner, service-discovery, vulnerability-detection, vulnerability-scanners
• Language: Python
• Homepage:
• Size: 1.39 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


# Probus - Network Scanner

[![codecov](https://codecov.io/github/royrusso/probus/graph/badge.svg?token=B972KDOOOB)](https://codecov.io/github/royrusso/probus)

![Tests](https://img.shields.io/github/actions/workflow/status/royrusso/probus/pytests_codecov.yml?label=Tests)

![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)

**This project is in early development!**

A network scanner with an attractive UI, that identifies security vulnerabilities in your network and alerts you to new ones as they arise. Scans are performed on a schedule or on-demand.

[Introduction](#bulb-introduction) \* [Key Features](#dart-key-features) \* [Quickstart](#zap-quickstart) \* [Development](#dizzy-development) \* [Contributing](#+1-contributing) \* [Contact](#incoming_envelope-contact)



## :dart: Key Features:

- **Network Scanner:** Asynchronously scans your network for hosts and open ports.

- **Scheduled Scans:** Scans your network on a schedule.

- **Vulnerability Scanner:** Identifies security vulnerabilities in your network on a per-device basis.

- **Scan and Vulnerability History:** Keeps a history of scans and vulnerabilities identified.

- **Alerting:** Alerts you to new vulnerabilities as they arise, new devices added to your network, given a network range.

- **Platform agnostic**: Avilable as a docker container.

## :zap: Quickstart

In order to run the commands described below, you need:

- [Docker](https://www.docker.com/)

- [Docker Compose](https://docs.docker.com/compose/)

### Running

1. Linux Installs: Run `docker compose up` to start the application.

2. Mac and Windows Installs: Run `NETWORK_MODE=bridge docker compose up` to start the application.

UI: [http://localhost:8080](http://localhost:8080)

API: [http://localhost:8000/docs](http://localhost:8000/docs)

> **Note:** The `NETWORK_MODE=bridge` environment variable is required for Mac and Windows. This is because the default network mode for Docker Compose is `host`, which is not supported on Mac and Windows and Probus requires access to the host network to scan the network.

Alternatively, you can create a `.env` file in the root of the project with the following content:

```bash

NETWORK_MODE=bridge

```

## :dizzy: Development

Please read the [DEVELOPMENT.md](DEVELOPMENT.md) file for more information on how to run this project locally and contribute.

## :+1: Contributing

Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information on how to contribute to this project.

## :incoming_envelope: Contact

- Use **GitHub Issues** for code-related issues.

## :file_cabinet: License

Probus is licensed under the [Apache License 2.0](LICENSE).