Commit graph

601 commits

Author SHA1 Message Date
Robin Sommer
c74effad42 Clarifying notice documentation.
Closes BIT-1405.
2016-05-27 13:22:24 -07:00
Daniel Thayer
f596d30386 Fix some scripting tutorial examples
Some of the examples in the scripting tutorial were regularly getting
out of sync with the base scripts (because the line numbering would need
to be updated).  Fixed this maintenance burden by using small example
scripts instead of actual Bro scripts.  These small example scripts
do not need to be kept in sync with the bro base scripts.
2016-05-05 17:23:15 -05:00
Daniel Thayer
2d9127888f Add some missing Bro script documentation
Also fixed a few reST formatting issues.
2016-05-05 16:35:31 -05:00
Daniel Thayer
28125e367e Fix more "make doc" warnings 2016-05-05 15:18:50 -05:00
Daniel Thayer
da6611e3c2 Merge remote-tracking branch 'origin/master' into topic/dnthayer/doc-improvements 2016-05-05 11:33:57 -05:00
Daniel Thayer
12eb7a380d Rename broker BIF wrapper functions in a few more places 2016-04-27 00:47:48 -05:00
Johanna Amann
e7ec537ed5 Merge remote-tracking branch 'origin/topic/dnthayer/broker-namespace'
* origin/topic/dnthayer/broker-namespace:
  Split the broker main.bro into two scripts
  Rename the BrokerStore namespace to Broker
  Rename the BrokerComm namespace to Broker

BIT-1563 #merged
2016-04-22 16:45:09 -07:00
Daniel Thayer
f54a5b52e5 Improve documentation of the "for" statement 2016-04-12 15:40:18 -05:00
Daniel Thayer
f46dfac63a Rename the BrokerStore namespace to Broker 2016-03-30 16:39:19 -05:00
Daniel Thayer
9f5c820c7b Rename the BrokerComm namespace to Broker 2016-03-30 14:31:25 -05:00
william
35a4e428cf Wrong regex literal in scripting doc 2016-03-26 01:54:51 -07:00
Robin Sommer
c916072e4c Merge remote-tracking branch 'origin/topic/johanna/freebsd9'
BIT-1542 #merged

* origin/topic/johanna/freebsd9:
  More detailed installation instructions for FreeBSD 9.X
2016-03-03 21:34:41 -08:00
Johanna Amann
f37139791a More detailed installation instructions for FreeBSD 9.X 2016-03-01 15:23:58 -08:00
Daniel Thayer
6ef8a93dca Update traffic per core estimate in the cluster doc 2016-01-27 14:56:42 -06:00
Johanna Amann
bf52f986c2 Update copyright year for sphinx.
That way, not all of our pages say '2013' anymore.
2016-01-21 13:47:33 -08:00
Johanna Amann
ad61267ce6 add new plugins so they are picked up by sphinx.
Also remove reference to dataseries.
2016-01-15 19:23:51 -08:00
Johanna Amann
895a56c019 Unbreak "make doc" after dataseries removal. 2016-01-15 17:21:39 -08:00
Daniel Thayer
c1d7337a73 Improve documentation of Bro script statements
Added more documentation of the "delete" statement.  Removed some other
text that was probably more confusing than helpful.
2016-01-12 15:35:29 -06:00
Robin Sommer
677f1172d9 Merge remote-tracking branch 'origin/topic/johanna/os-x-openssl'
* origin/topic/johanna/os-x-openssl:
  Update installation instructions to add os-x openssl dependency.

BIT-1506 #merged
2015-12-18 11:27:10 -08:00
Johanna Amann
cf97d1e991 Update installation instructions to add os-x openssl dependency.
Also remove blob about binary mac packages, which we no longer provide.
2015-12-01 13:13:48 -08:00
Daniel Thayer
6ff68ce6ae Update and improve install instructions
Added info about optional dependencies, and what to do when the configure
script fails.  A few other clarifications and updates.
2015-09-22 17:42:58 -05:00
Daniel Thayer
8896679a01 More improvements to input framework documentation
Fixed more typos, reformatted the code examples to remove the
horizontal scroll bars, and removed some redundant sections that were
just outdated copies of information in the auto-generated reference
docs.
2015-09-22 17:41:24 -05:00
Daniel Thayer
160b852f64 Update install instructions for CAF 2015-09-22 13:03:28 -05:00
Daniel Thayer
401743313c Fixed some examples in "Writing Bro Scripts" doc 2015-09-14 13:30:25 -05:00
Daniel Thayer
bebd08484c Clarifications to the script reference docs 2015-09-07 03:35:23 -05:00
Daniel Thayer
ab8a8d3ef3 Split long lines in input framework docs 2015-08-21 16:30:51 -05:00
Daniel Thayer
7ce0cefcba Minor clarifications and typo fixes in broker doc 2015-08-19 13:28:35 -05:00
Daniel Thayer
92c5885f06 Remove unnecessary blank lines from some broker doc files 2015-08-18 15:50:58 -05:00
Daniel Thayer
f56b3ebd93 Fix some doc build warnings 2015-08-18 14:23:48 -05:00
Daniel Thayer
c6dec18e2b Improve documentation of table and set types
Add a list of the types that are not allowed to be the index type
of a table or set.
2015-08-17 16:24:02 -05:00
Daniel Thayer
0687b4f601 Merge remote-tracking branch 'origin/master' into topic/dnthayer/doc-fixes 2015-08-17 14:53:06 -05:00
Robin Sommer
c91792b762 Merge branch 'topic/jswaro/feature/HookAddToAnalyzer-tcprs-support' of https://github.com/jswaro/bro
Making two changes here:

    - Renaming the hook to SetupAnalyzerTree.

    - Reverting the reversal of the script load order. Instead, I'm
      adding an additional script that Bro looks for to load first,
      "__preload__.bro". Also extending the plugin docs to cover this.

    - Increasing plugin API version, as I suppose adding a new virtual
      function may invalidate binary compatibility.

* 'topic/jswaro/feature/HookAddToAnalyzer-tcprs-support' of https://github.com/jswaro/bro:
  Add hook 'HookAddToAnalyzerTree' to support TCPRS plugin
2015-08-10 15:05:48 -07:00
Robin Sommer
9efd54a08a Merge remote-tracking branch 'origin/topic/dnthayer/ticket1440'
* origin/topic/dnthayer/ticket1440:
  Remove build dependency on perl
2015-08-07 13:10:08 -07:00
Daniel Thayer
6d031c41f1 Significant improvements to the GeoLocation doc
Updated the install section for FreeBSD and OS X.
Added a section to explain how to quickly test that everything is
setup correctly.
Improved the usage section by removing the misleading record definition
(a link to the reference doc is provided), and explaining that some
fields will be uninitialized.
Corrected the example so that it doesn't try to access uninitialized
fields.
2015-08-04 22:00:54 -05:00
Robin Sommer
8ad504ad4f Enabling Broker by default.
This means CAF is now a required dependency. For now, I'm keeping a
switch --disable-broker to turn it off, but I'm thinking that
eventually we should remove that as well.
2015-07-21 18:20:34 -07:00
Justin Azoff
8d8dc890dd Correct perl package name on freebsd
Based on feedback on IRC, the correct package name is 'perl5', not 'perl'
2015-07-10 08:35:18 -04:00
Robin Sommer
26d10d88d2 Merge remote-tracking branch 'origin/topic/dnthayer/doc-improvements-2.4'
Lots of good stuff! Thanks for catchign the plugin doc inconsistencies!

* origin/topic/dnthayer/doc-improvements-2.4:
  Add missing documentation on the "Bro Package Index" page
  More improvements to the Logging Framework doc
  Fix documentation typo
  Update the "Log Files" documentation
  Add links in the logging framework doc
  Add a link to the bro-plugins documentation
  Update bro man page
  Update script language reference documentation
  Fix typos in the "writing bro plugins" doc
  Fix a "make doc" warning
  Improve logging framework doc
  Add link to broctl doc from the quickstart doc
  Update install documentation and fix some typos
  Minor improvements to logging framework documentation
  Correct a minor typo in the docs
2015-06-02 09:44:51 -07:00
Daniel Thayer
63aa61fcc9 More improvements to the Logging Framework doc 2015-06-01 16:36:44 -05:00
Daniel Thayer
4db9b8d792 Update the "Log Files" documentation 2015-06-01 14:26:09 -05:00
Daniel Thayer
b6920ac188 Add links in the logging framework doc
Added links to the log writers that are available as external plugins.
2015-05-31 23:34:19 -05:00
Daniel Thayer
648d091b29 Add a link to the bro-plugins documentation 2015-05-31 23:17:59 -05:00
Daniel Thayer
d0e304de46 Update script language reference documentation 2015-05-30 01:35:55 -05:00
Daniel Thayer
260b25f20a Fix typos in the "writing bro plugins" doc 2015-05-30 00:18:04 -05:00
Daniel Thayer
7cf04c9f3a Improve logging framework doc
Reorganized the content to be easier to follow, added a few more examples,
fixed some ugly formatting (removed scrollbars that make the examples
difficult to read).
2015-05-28 17:52:32 -05:00
Daniel Thayer
e02ad1711c Add link to broctl doc from the quickstart doc 2015-05-27 16:23:02 -05:00
Daniel Thayer
fcaf1d9c95 Update install documentation and fix some typos 2015-05-25 13:08:03 -05:00
Johanna Amann
244dffa8fc update installation instructions and remove outdated references. 2015-04-24 10:33:22 -07:00
Jon Siwek
fc790ca096 Clarify Broker examples by using an explicit/hardcoded listen port. 2015-04-21 16:38:51 -05:00
Robin Sommer
6fb4b522c6 Slight doc tweak flagged by test. 2015-04-20 20:44:06 -07:00
Robin Sommer
ed91732e09 Merge remote-tracking branch 'origin/topic/seth/more-file-type-ident-fixes'
* origin/topic/seth/more-file-type-ident-fixes:
  File API updates complete.
  Fixes for file type identification.
  API changes to file analysis mime type detection.
  Make HTTP 206 reassembly require ETags by default.
  More file type identification improvements
  Fix an issue with files having gaps before the bof_buffer is filled.
  Fix an issue with packet loss in http file reporting.
  Adding WOFF fonts to file type identification.
  Extended JSON matching and added OCSP responses.
  Another large signature update.
  More signature updates.
  Even more file type ident clean up.
  Lots of fixes for file type identification.

BIT-1368 #merged
2015-04-20 13:31:00 -07:00