evan/overseer
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
A port scanning web interface that allows you to compare historical results while storing them to a database.
6 Commits 1 Branch 0 Tags 6.6 MiB
Python 51.4%
Vue 37.1%
JavaScript 8.5%
HTML 2.4%
Dockerfile 0.6%
042f83a035
Go to file
Evan Reichard 042f83a035 pre-commit black & flake8
2021-03-18 09:01:07 -04:00
src pre-commit black & flake8 2021-03-18 09:01:07 -04:00
.gitignore Initial Commit 2021-03-16 17:56:23 -04:00
.pre-commit-config.yaml pre-commit black & flake8 2021-03-18 09:01:07 -04:00
MANIFEST.in Initial Commit 2021-03-16 17:56:23 -04:00
README.md Database Models & Connector 2021-03-17 22:19:03 -04:00
setup.py pre-commit black & flake8 2021-03-18 09:01:07 -04:00

README.md

Overseer

Description

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

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

Running

Ideally from a virtual env:

overseer run

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.