This document provides an overview of the NIDS operator manual. It includes information on how to install, configure, and use the NIDS service. Ideally, NIDS is meant to be run on a server that is connected to a network that you would like to monitor. NIDS hosts a web interface that allows users to view network traffic and alerts in real-time. If for any reason the web interface is not accessible, the NIDS service can still be managed via the terminal interface.
Note that NIDS is designed to run on a Linux-based system. It also functions without regard to any other docker services and will not hesistate to remove them. Adjust your installation environment accordingly.
To install NIDS, follow the steps below:
- Clone the repository to a preferred directory:
git clone https://github.com/IsaiahHarvi/NIDS.git
- Navigate to the NIDS directory:
cd NIDS
- Run Install script:
./scripts/install.sh
This will install any needed dependencies.
To use NIDS, follow the steps below:
- Ensure you are in the NIDS directory:
cd /path/to/NIDS
- Start the NIDS service:
./scripts/deploy.sh
- Access the web interface by navigating to
http://localhost:5000in your preferred web browser.
The web interface provides a visual representation of network traffic and alerts in real-time as well as the ability to manage the NIDS service.
- Access the terminal interface by running:
python3 scripts/display.py
The terminal interface provides direct control over the NIDS service. It is useful for managing the service when the web interface is not accessible. But currently does not provide monitoring tools.
If you encounter any issues with the NIDS service, please refer to the following troubleshooting steps:
- Uninstall
./scripts/uninstall.sh
- Reinstall & Run
./scripts/install.sh
./scripts/deploy.sh