Installing Bro

Prerequisites

Before installing Bro, you’ll need to ensure that some dependencies are in place.

Required Dependencies

Bro requires the following libraries and tools to be installed before you begin:

To build Bro from source, the following additional dependencies are required:

To install the required dependencies, you can use (when done, make sure that bash and python are in your PATH):

  • RPM/RedHat-based Linux:

    sudo yum install cmake make gcc gcc-c++ flex bison libpcap-devel openssl-devel python-devel swig zlib-devel
    
  • DEB/Debian-based Linux:

    sudo apt-get install cmake make gcc g++ flex bison libpcap-dev libssl-dev python-dev swig zlib1g-dev
    
  • FreeBSD:

    Most required dependencies should come with a minimal FreeBSD install except for the following.

    sudo pkg_add -r bash cmake swig bison python perl
    
  • Mac OS X:

    Compiling source code on Macs requires first downloading Xcode, then going through its “Preferences...” -> “Downloads” menus to install the “Command Line Tools” component.

    OS X comes with all required dependencies except for CMake and SWIG. Distributions of these dependencies can likely be obtained from your preferred Mac OS X package management system (e.g. MacPorts, Fink, or Homebrew). Specifically for MacPorts, the cmake, swig, and swig-python packages provide the required dependencies.

Optional Dependencies

Bro can make use of some optional libraries and tools if they are found at build time:

  • LibGeoIP (for geolocating IP addresses)
  • sendmail (enables Bro and BroControl to send mail)
  • gawk (enables all features of bro-cut)
  • curl (used by a Bro script that implements active HTTP)
  • gperftools (tcmalloc is used to improve memory and CPU usage)
  • ipsumdump (for trace-summary; http://www.cs.ucla.edu/~kohler/ipsumdump)
  • Ruby executable, library, and headers (for Broccoli Ruby bindings)

LibGeoIP is probably the most interesting and can be installed on most platforms by following the instructions for installing libGeoIP and the GeoIP database.

Installing Bro

Bro can be downloaded in either pre-built binary package or source code forms.

Using Pre-Built Binary Release Packages

See the bro downloads page for currently supported/targeted platforms for binary releases.

  • RPM

    sudo yum localinstall Bro-*.rpm
    
  • DEB

    sudo gdebi Bro-*.deb
    
  • MacOS Disk Image with Installer

    Just open the Bro-*.dmg and then run the .pkg installer. Everything installed by the package will go into /opt/bro.

The primary install prefix for binary packages is /opt/bro. Non-MacOS packages that include BroControl also put variable/runtime data (e.g. Bro logs) in /var/opt/bro.

Installing from Source

Bro releases are bundled into source packages for convenience and are available on the bro downloads page. Alternatively, the latest Bro development version can be obtained through git repositories hosted at git.bro.org. See our git development documentation for comprehensive information on Bro’s use of git revision control, but the short story for downloading the full source code experience for Bro via git is:

git clone --recursive git://git.bro.org/bro

Note

If you choose to clone the bro repository non-recursively for a “minimal Bro experience”, be aware that compiling it depends on several of the other submodules as well.

The typical way to build and install from source is (for more options, run ./configure --help):

./configure
make
make install

The default installation path is /usr/local/bro, which would typically require root privileges when doing the make install. A different installation path can be chosen by specifying the --prefix option. Note that /usr and /opt/bro are the standard prefixes for binary Bro packages to be installed, so those are typically not good choices unless you are creating such a package.

Depending on the Bro package you downloaded, there may be auxiliary tools and libraries available in the aux/ directory. Some of them will be automatically built and installed along with Bro. There are --disable-* options that can be given to the configure script to turn off unwanted auxiliary projects that would otherwise be installed automatically. Finally, use make install-aux to install some of the other programs that are in the aux/bro-aux directory.

OpenBSD users, please see our FAQ if you are having problems installing Bro.

Finally, if you want to build the Bro documentation (not required, because all of the documentation for the latest Bro release is available on the Bro web site), there are instructions in doc/README in the source distribution.

Configure the Run-Time Environment

Just remember that you may need to adjust your PATH environment variable according to the platform/shell/package you’re using. For example:

Bourne-Shell Syntax:

export PATH=/usr/local/bro/bin:$PATH

C-Shell Syntax:

setenv PATH /usr/local/bro/bin:$PATH

Or substitute /opt/bro/bin instead if you installed from a binary package.

Copyright 2013, The Bro Project. Last updated on July 31, 2014. Created using Sphinx 1.1.3.