https://github.com/bryopsida/network-scanner

An api for configuring scheduled scans and persisting results to couchdb
https://github.com/bryopsida/network-scanner

bullmq containerized couchdb helm horizontal-scaling kubernetes nestjs network-mapper port-scanner redis work-in-progress

Last synced: 9 days ago
JSON representation

An api for configuring scheduled scans and persisting results to couchdb

• Host: GitHub
• URL: https://github.com/bryopsida/network-scanner
• Owner: bryopsida
• License: mit
• Created: 2023-07-22T23:57:00.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-10T01:51:30.000Z (7 months ago)
• Last Synced: 2024-04-10T04:13:48.416Z (7 months ago)
• Topics: bullmq, containerized, couchdb, helm, horizontal-scaling, kubernetes, nestjs, network-mapper, port-scanner, redis, work-in-progress
• Language: TypeScript
• Homepage:
• Size: 222 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Network Scanner

## What does this do?

Provides a REST Api for defining scheduled scans, results of scans are stored in couchdb.

## NPM Scripts

| Syntax             | Description                                                         |

| ------------------ | ------------------------------------------------------------------- |

| minikube:start     | Creates a minikube cluster for testing                              |

| minikube:stop      | Stops the minikube cluster                                          |

| minikube:delete    | Deletes the minikube cluster                                        |

| minikube:copyImage | Load the build image from build:image into the minikube cluster     |

| build              | Compile the TypeScript to JavaScript                                |

| build:image        | Build the container image                                           |

| build:docs         | Builds the docs folder                                              |

| start:dev          | Run the server with hot reloading on save                           |

| start              | Start the server                                                    |

| lint               | Check if code passes linting rules                                  |

| lint:fix           | Automatically fix any formatting or linting rules that can be fixed |

| helm:deploy        | Deploy the chart with the local to your cluster                     |

| helm:uninstall     | Delete the chart release from your cluster                          |

| helm:test          | Run the packaged tests (postman) for the helm release               |

| test               | Run the unit tests                                                  |

## How to use published chart

First add the repo `helm repo add network-scanner  https://bryopsida.github.io/network-scanner/`, then fetch updates `helm repo update`, and finally, install with `helm upgrade --install scanner network-scanner/network-scanner --wait`.