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

Update README.

Browse source
This commit is contained in:
Zeke Medley 2019-07-03 11:40:34 -07:00
parent c03ef308c9
commit aa25a97f36
3 changed files with 53 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README
View file

@ -1,36 +0,0 @@
=============================
Zeek Network Security Monitor
=============================
Zeek is a powerful framework for network analysis and security
monitoring.
(Zeek is the new name for the long-established Bro system. Note that
parts of the system retain the "Bro" name, and it also often appears in
the documentation and distributions.)
Please see the INSTALL file for installation instructions and pointers
for getting started. NEWS contains release notes for the current
version, and CHANGES has the complete history of changes. Please see
COPYING for licensing information.
You can download source and binary releases on:
https://www.zeek.org/download
To get the current development version, clone our master git
repository:
git clone --recursive https://github.com/zeek/zeek
For more documentation, research publications, and community contact
information, please see the home page:
https://www.zeek.org
On behalf of the Zeek Development Team,
Vern Paxson & Robin Sommer,
International Computer Science Institute &
Lawrence Berkeley National Laboratory
vern@icir.org / robin@icir.org

53
README.md Normal file
View file

@ -0,0 +1,53 @@
<h1 align="center">
<br>
<a href="https://www.zeek.org">
<img src="https://www.zeek.org/images/bro-eyes.png" alt="The Zeek Logo" />
</a>
<br><br>
The Zeek Network Security Monitor
<br>
</h1>
<h4 align="center">A <a href ="https://www.zeek.org/why_choose_zeek.pdf">powerful</a> framework for network analysis and security monitoring.</h4>
<p align="center">
<a href="#key-features">Key Features</a> -
<a href="https://docs.zeek.org/en/stable/index.html">Documentation</a> -
<a href="#getting-started">Getting Started</a> -
<a href="#development">Development</a> -
<a href="#license">License</a>
</p>
## Key Features
* <b>Adaptable and Flexible</b>
Zeek's domain-specific scripting language enables site-specific monitoring policies and means that it is not restricted to any particular detection approach.
* <b>In-depth Analysis</b>
Zeek comes with analyzers for many protocols, enabling high-level semantic analysis at the application layer.
* <b>Efficient</b>
Zeek targets high-performance networks and is used operationally at a variety of large sites.
* <b>Highly Stateful</b>
Zeek keeps extensive application-layer state about the network it monitors and provides a high-level archive of a network's activity.
## Getting Started
The best place to find information about getting started with Zeek is our [website](https://www.zeek.org/documentation/index.html). You can find downloads for stable relases, tutorials on getting Zeek set up, and many other useful resources there. You can also find release notes for the current version in [NEWS](https://github.com/zeek/zeek/blob/master/NEWS), and [CHANGES](https://github.com/zeek/zeek/blob/master/CHANGES) has the complete history of changes
To work on the development branch of Zeek, clone the master git repository.
`git clone --recursive https://github.com/zeek/zeek `
Then, with its [dependencies](https://docs.zeek.org/en/stable/install/install.html#prerequisites) installed, build and install.
`./configure && make && sudo make install`
## Development
Zeek was originally developed by Vern Paxson. Robin Sommer now leads the project, jointly with a core team of researchers and developers at the [International Computer Science Institute](http://www.icsi.berkeley.edu) in Berkeley, CA; and the [National Center for Supercomputing Applications](http://www.ncsa.illinois.edu) in Urbana-Champaign, IL.
Zeek is developed on GitHub and we welcome contributions. Working on an open-source project like Zeek can be an incredibly rewarding experience. We actively collect feature requests and issues on GitHub [here](https://github.com/zeek/zeek/issues). If you're looking for a good first issue you might find [these](https://github.com/zeek/zeek/issues?q=is%3Aissue+is%3Aopen+label%3A%22Difficulty%3A+Easy%22) useful.
More information on Zeek's development can be found [here](https://www.zeek.org/development/index.html), and information about its community and mailing lists (which are fairly active) can be found [here](https://www.zeek.org/community/index.html).
## License
Zeek comes with a BSD license, allowing for free use with virtually no restrictions. You can read it [here](https://github.com/zeek/zeek/blob/master/COPYING).

1
README.rst
View file

@ -1 +0,0 @@
README