Bro Documentation

Guides

• Installing Bro
• Quick Start Guide
• Upgrading From Bro 1.5 to 2.0
• Frequently Asked Questions
• Reporting Problems

Frameworks

• Notice Framework
• Customizing Bro’s Logging
• Bro Cluster
• Signatures

How-Tos

• GeoLocation

Script Reference

• Index of All Bro Script Packages
• Index of All Individual Bro Scripts
• Builtin Types and Attributes
• Built-In Functions (BIFs)

Other Bro Components

The following are snapshots of documentation for components that come with this version of Bro (2.0-86). Since they can also be used independently, see the download page for documentation of any current, independent component releases.

• BinPAC - A protocol parser generator
• Broccoli - The Bro Client Communication Library (README)
• Broccoli - User Manual
• Broccoli Python Bindings
• Broccoli Ruby Bindings
• BroControl - Interactive Bro management shell
• Bro-Aux - Small auxiliary tools for Bro
• BTest - A unit testing framework
• Capstats - Command-line packet statistic tool
• PySubnetTree - Python module for CIDR lookups
• trace-summary - Script for generating break-downs of network traffic

The Broccoli API Reference may also be of interest.

Other Indices and References

• General Index
• Notice Index
• Search Page

Internal References

• Internal Scripts