pdf/bronzeburner
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

* docs(README.md): add FAQ section with two questions and answers

Browse source
This commit is contained in:
Darryl Nixon 2023-09-06 19:50:10 -07:00
parent 03da628584
commit 6450f84a38
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -10,6 +10,7 @@ use it to monitor your enterprise's ports over time<br/>
[About](#about) • [About](#about) •
[Installation](#installation) • [Installation](#installation) •
[Example](#example) • [Example](#example) •
[FAQ](#faq) •
[Contributing](#contributing) • [Contributing](#contributing) •
[License](#license) [License](#license)
</div> </div>
@ -81,6 +82,17 @@ example execution below.
TBD 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 <options> > out.log`.
## Contributing ## Contributing
If you would like to contribute to this project, feel free to submit a pull request or open an issue on GitHub. If you would like to contribute to this project, feel free to submit a pull request or open an issue on GitHub.