RPC Detection Service

Description

This is an RPC server that provides a simple API for running different types of detectors on demand.
The server can be run either locally or as a Docker container.

Adding new detectors

A detailed guide for adding new detectors
Note that detector execution time is being restricted to a reasonable amount of time.

Requirements

• Node.js 18 or higher.
• Docker and docker-compose (if running as a Docker container).
  
  

Installation

1. Clone the repository:

   git clone https://github.com/ironblocks/detection-sdk.git

2. Change into the project directory:

   cd detection-sdk

3. Install dependencies:

   npm install

Running the server

Running Locally

npm start

The server will start on: http://localhost:8000

Running as a Docker Container

1. Build the Docker image:

   docker-compose build

2. Start the Docker container:

   docker-compose up

3. The server will be available at http://0.0.0.0:80

Configuration

The server can be configured via environment variables. The following variables are supported:

• HOST: the host to which the server will bind (default: localhost)
• PORT: the port on which the server will listen (default: 8000)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

This project is licensed under the Ironblocks License.

Contact

If you have any questions or concerns, please open an issue or contact us at hello@ironblocks.com.