Skip to content

rtbrick/bngblaster-controller

Repository files navigation

BNG Blaster Control Daemon

Build License Documentation API

The BNG Blaster controller provides a REST API to start and stop multiple test instances. It exposes the BNG Blaster JSON RPC API as REST API and provides endpoints to download logs and reports.

BNG Blaster Controller

Usage

The controller comes with good defaults, just starting the controller will give you an instance that:

  • runs on port 8001
  • assumes bngblaster is installed at /usr/sbin/bngblaster
  • uses /var/bngblaster as storage directory

The blaster instance needs at least the permissions required to run the bngblaster itself.

$ ./bngblasterctrl -h
Usage of bngblasterctrl:
  -addr string
    	HTTP network address (default ":8001")
  -color
    	turn on color of color output
  -console
    	turn on pretty console logging (default true)
  -d string
    	config folder (default "/var/bngblaster")
  -debug
    	turn on debug logging
  -e string
    	bngblaster executable (default "/usr/sbin/bngblaster")
  -upload
    	allow file upload

License

BNG Blaster is licensed under the BSD 3-Clause License, which means that you are free to get and use it for commercial and non-commercial purposes as long as you fulfill its conditions.

See the LICENSE file for more details.

Copyright

Copyright (C) 2020-2024, RtBrick, Inc.

Contact

bngblaster@rtbrick.com