A port scanning web interface that allows you to compare historical results while storing them to a database.

Go to file

Evan Reichard 6b40111a3b Update Notifications, Fix DB Cleanup, Error Handling, Move ScanResult to Component		2021-03-21 12:28:02 -04:00
src	Update Notifications, Fix DB Cleanup, Error Handling, Move ScanResult to Component	2021-03-21 12:28:02 -04:00
tests/overseer	Docs, Tests, SIGINT	2021-03-20 23:15:22 -04:00
.gitignore	Update Notifications, Fix DB Cleanup, Error Handling, Move ScanResult to Component	2021-03-21 12:28:02 -04:00
.pre-commit-config.yaml	Docs, Tests, SIGINT	2021-03-20 23:15:22 -04:00
docker-compose.yml	Docker configuration	2021-03-20 22:16:24 -04:00
Dockerfile	Docker configuration	2021-03-20 22:16:24 -04:00
MANIFEST.in	Docker configuration	2021-03-20 22:16:24 -04:00
README.md	Docker configuration	2021-03-20 22:16:24 -04:00
setup.py	Docs, Tests, SIGINT	2021-03-20 23:15:22 -04:00

README.md

Overseer

Description

Overseer is a port scanning web interface. All current and historical results are stored in a database.

Running

# Be sure image is built
docker-compose build

# Run compose in background. Service accessible via localhost:5000
docker-compose up -d

Developing

Server

Ideally from a virtualenv:

python setup.py develop

Client

At this point, you have to build the client to appropriately populate the static resources for the Flask server to serve up.

Building

Overseer consists of a server and client component.

Server:

Ideally from a virtualenv:

python setup.py install

Client:

You must run these commands from the ./src/overseer_client/ directory:

yarn build

Notes

In a production environment, it would be ideal to setup something like nginx to properly forward the /api/* routes to the Flask server, and all other endpoints to the static client resources.