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

More improvements to install/setup documentation

Browse source 
Addresses BIT-1160
This commit is contained in:
Daniel Thayer 2014-03-19 16:56:29 -05:00
parent 2e8d0945a4
commit 80fe5874a5
4 changed files with 16 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/cluster/index.rst
View file

@ -13,7 +13,7 @@ processes examining packets and doing correlation activities but acting as
a singular, cohesive entity. This document describes the Bro cluster a singular, cohesive entity. This document describes the Bro cluster
architecture. For information on how to configure a Bro cluster, architecture. For information on how to configure a Bro cluster,
see the documentation for see the documentation for
`BroControl <http://bro.org/sphinx/components/broctl/README.html>`_. :doc:`BroControl <../components/broctl/README>`.
Architecture Architecture
--------------- ---------------

17
doc/install/guidelines.rst
View file

@ -1,16 +1,21 @@
.. _upgrade-guidelines: .. _upgrade-guidelines:
================== ==============
General Guidelines How to Upgrade
================== ==============
If you're doing an upgrade install (rather than a fresh install), If you're doing an upgrade install (rather than a fresh install),
there's two suggested approaches: either install Bro using the same there's two suggested approaches: either install Bro using the same
installation prefix directory as before, or pick a new prefix and copy installation prefix directory as before, or pick a new prefix and copy
local customizations over. In the following we summarize general local customizations over. Regardless of which approach you choose,
guidelines for upgrading, see the :ref:`release-notes` for if you are using BroControl, then after upgrading Bro you will need to
version-specific information. run "broctl check" (to verify that your new configuration is OK)
and "broctl install" to complete the upgrade process.
In the following we summarize general guidelines for upgrading, see
the :ref:`release-notes` for version-specific information.
Reusing Previous Install Prefix Reusing Previous Install Prefix
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

2
doc/install/install.rst
View file

@ -80,7 +80,7 @@ that ``bash`` and ``python`` are in your ``PATH``):
Distributions of these dependencies can likely be obtained from your Distributions of these dependencies can likely be obtained from your
preferred Mac OS X package management system (e.g. MacPorts_, Fink_, preferred Mac OS X package management system (e.g. MacPorts_, Fink_,
or Homebrew_). Specifically for MacPorts, the ``cmake``, ``swig``, or Homebrew_). Specifically for MacPorts, the ``cmake``, ``swig``,
``swig-python`` and packages provide the required dependencies. and ``swig-python`` packages provide the required dependencies.
Optional Dependencies Optional Dependencies

6
doc/quickstart/index.rst
View file

@ -15,7 +15,7 @@ source code forms. See :ref:`installing-bro` for instructions on how to
install Bro. install Bro.
In the examples below, ``$PREFIX`` is used to reference the Bro In the examples below, ``$PREFIX`` is used to reference the Bro
installation root directory, which by default is ``/usr/local/bro/`` if installation root directory, which by default is ``/usr/local/bro`` if
you install from source. you install from source.
Managing Bro with BroControl Managing Bro with BroControl
@ -25,8 +25,8 @@ BroControl is an interactive shell for easily operating/managing Bro
installations on a single system or even across multiple systems in a installations on a single system or even across multiple systems in a
traffic-monitoring cluster. This section explains how to use BroControl traffic-monitoring cluster. This section explains how to use BroControl
to manage a stand-alone Bro installation. For instructions on how to to manage a stand-alone Bro installation. For instructions on how to
configure a Bro cluster, see the documentation for `BroControl configure a Bro cluster, see the documentation for :doc:`BroControl
<http://bro.org/sphinx/components/broctl/README.html>`_. <../components/broctl/README>`.
A Minimal Starting Configuration A Minimal Starting Configuration
-------------------------------- --------------------------------