From 6450f84a385b61dcc12be25c6a0b51896b551b8b Mon Sep 17 00:00:00 2001 From: Darryl Nixon Date: Wed, 6 Sep 2023 19:50:10 -0700 Subject: [PATCH] * docs(README.md): add FAQ section with two questions and answers --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 1476234..19433c4 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ use it to monitor your enterprise's ports over time
[About](#about) • [Installation](#installation) • [Example](#example) • +[FAQ](#faq) • [Contributing](#contributing) • [License](#license) @@ -81,6 +82,17 @@ example execution below. TBD +## FAQ + +**This scans all ports? Isn't that slow?** + +It can be if you use nmap. RustScan, which bronzeburner uses, multiprocesses nmap and is capable of scanning all ports on a single host in as fast as three seconds! + + +**I see timestamp data is saved in the time series DB, but I'd also like some logging. What's my best bet?** + +bronzeburner logs comprehensively to STDOUT, so simply forward the output of bronzeburner to a file with `bronzeburner > out.log`. + ## Contributing If you would like to contribute to this project, feel free to submit a pull request or open an issue on GitHub.