Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 06:38:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge branch 'topic/robin/cleanup'

Browse source 
* topic/robin/cleanup:
  Cleaning up some distribution files.
This commit is contained in:
Robin Sommer 2011-10-18 14:21:54 -07:00
commit d86525ce61
2 changed files with 43 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

97
INSTALL
View file

@ -8,53 +8,31 @@ Prerequisites
Bro relies on the following libraries and tools, which need to be installed Bro relies on the following libraries and tools, which need to be installed
before you begin: before you begin:
* A C/C++ compiler * CMake 2.6 or greater http://www.cmake.org
* Libpcap headers and libraries * Libpcap (headers and libraries) http://www.tcpdump.org
Network traffic capture library
* Flex (Fast Lexical Analyzer) * OpenSSL (headers and libraries) http://www.openssl.org
Flex is already installed on most systems, so with luck you can
skip having to install it yourself.
* Bison (GNU Parser Generator) Bro can make uses of some optional libraries if they are found at
This comes with many systems, but if you get errors compiling
parse.y, you will need to install it.
* Perl
Used only during the Bro build process
* sed
Used only during the Bro build process
* BIND8 headers and libraries
These are usually already installed as well.
* OpenSSL headers and libraries
For analysis of SSL certificates by the HTTP analyzer, and
for encrypted Bro-to-Bro communication. These are likely installed,
though some platforms may require installation of a 'devel' package
for the headers.
* CMake 2.6 or greater
CMake is a cross-platform, open-source build system, typically
not installed by default. See http://www.cmake.org for more
information regarding CMake and the installation steps below for
how to use it to build this distribution. CMake generates native
Makefiles that depend on GNU Make by default.
Bro can also make uses of some optional libraries if they are found at
installation time: installation time:
* Libmagic * Libmagic For identifying file types (e.g., in FTP transfers).
For identifying file types (e.g., in FTP transfers).
* LibGeoIP * LibGeoIP For geo-locating IP addresses.
For geo-locating IP addresses.
* Libz For decompressing HTTP bodies by the HTTP analyzer, and for
compressed Bro-to-Bro communication.
Bro also needs the following tools, but on most systems they will
already come preinstalled:
* BIND8 (headers and libraries)
* Bison (GNU Parser Generator)
* Flex (Fast Lexical Analyzer)
* Perl (Used only during the Bro build process)
* Libz
For decompressing HTTP bodies by the HTTP analyzer, and for
compressed Bro-to-Bro communication.
Installation Installation
============ ============
@ -65,26 +43,30 @@ To build and install into ``/usr/local/bro``::
> make > make
> make install > make install
This will perform an out-of-source build into a directory called This will first build Bro into a directory inside the distribution
``build/``, using default build options. It then installs the Bro binary called ``build/``, using default build options. It then installs all
into ``/usr/local/bro/bin``. Depending on the Bro package you required files into ``/usr/local/bro``, including the Bro binary in
downloaded, there may be auxiliary tools and libraries available in the ``/usr/local/bro/bin/bro``.
``aux/`` directory. All of them except for ``aux/bro-aux`` will also be
built and installed by doing ``make install``. To install the programs
that come in the ``aux/bro-aux`` directory, additionally use ``make
install-aux``. There are ``--disable`` options that can be given to the
configure script to turn off unwanted auxiliary projects.
You can specify a different installation directory with:: You can specify a different installation directory with::
> ./configure --prefix=<dir> > ./configure --prefix=<dir>
Note that ``/usr`` and ``/opt/bro`` are standard prefixes for binary Note that ``/usr`` and ``/opt/bro`` are the standard prefixes for
packages to be installed, so those are typically not good choices binary Bro packages to be installed, so those are typically not good
unless you are creating such a package. choices unless you are creating such a package.
Run ``./configure --help`` for more options. Run ``./configure --help`` for more options.
Depending on the Bro package you downloaded, there may be auxiliary
tools and libraries available in the ``aux/`` directory. All of them
except for ``aux/bro-aux`` will also be built and installed by doing
``make install``. To install the programs that come in the
``aux/bro-aux`` directory, use ``make install-aux``. There are
``--disable-*`` options that can be given to the configure script to
turn off unwanted auxiliary projects.
Running Bro Running Bro
=========== ===========
@ -94,13 +76,14 @@ available here:
http://www.bro-ids.org/documentation/quickstart.html http://www.bro-ids.org/documentation/quickstart.html
For developers that wish to run Bro from the the ``build/`` directory
after performing ``make``, but without performing ``make install``, they For developers that wish to run Bro directly from the ``build/``
will have to first set ``BROPATH`` to look for scripts inside the build directory (i.e., without performing ``make install``), they will have
to first adjust ``BROPATH`` to look for scripts inside the build
directory. Sourcing either ``build/bro-path-dev.sh`` or directory. Sourcing either ``build/bro-path-dev.sh`` or
``build/bro-path-dev.csh`` as appropriate for the current shell ``build/bro-path-dev.csh`` as appropriate for the current shell
accomplishes this and also augments your ``PATH`` so you can use Bro accomplishes this and also augments your ``PATH`` so you can use the
without qualifying the path to it. e.g.:: Bro binary directly:
> ./configure > ./configure
> make > make

10
README
View file

@ -3,11 +3,9 @@ Bro Network Security Monitor
============================ ============================
Bro is a powerful framework for network analysis and security Bro is a powerful framework for network analysis and security
monitoring. monitoring. Please see the INSTALL file for installation instructions
and pointers for getting started. For more documentation, research
Please see the INSTALL file for installation instructions and pointers publications, and community contact information, see Bro's home page:
for getting started. For more documentation, research publications, or
community contact information see Bro's home page:
http://www.bro-ids.org http://www.bro-ids.org
@ -19,5 +17,3 @@ Vern Paxson & Robin Sommer,
International Computer Science Institute & International Computer Science Institute &
Lawrence Berkeley National Laboratory Lawrence Berkeley National Laboratory
vern@icir.org / robin@icir.org vern@icir.org / robin@icir.org