README.md

   1                      dabba
   2
   3        Distributed network monitoring tools
   4
   5        Copyright (C) 2011 Emmanuel Roullit
   6
   7         https://github.com/eroullit/dabba
   8
   9 What is dabba?
  10 ==============
  11
  12 dabba is a set of network tools written for Linux.
  13
  14 The project has 3 main components:
  15     - `libdabba` - low-level zero-copy network library
  16     - `dabbad` - multi-threaded task manager and IPC query processor
  17     - `dabba` - CLI 'à la git' to communicate with dabbad and submit tasks
  18
  19 Currently supported feature are listed in the `CODING` file.
  20
  21 Get the source!
  22 ===============
  23
  24 ```
  25 git clone git://github.com/eroullit/dabba.git
  26 ```
  27
  28 Contributions are welcome, [CODING] regroups all information about it.
  29
  30 Prerequisites
  31 =============
  32
  33 dabba needs these to compile and run properly:
  34         - Linux kernel >= 2.6.31
  35         - `cmake`
  36         - `pthread`
  37         - `setcap` (within `libcap` package)
  38
  39 Recommended optional packages:
  40         - `python-yaml`
  41         - `doxygen`
  42
  43 Installation
  44 ============
  45
  46 To build out-of-tree:
  47 ```sh
  48 $ mkdir build && cd build && cmake .. && make
  49 ```
  50
  51 To install it after being built:
  52 ```sh
  53 $ sudo make install/strip
  54 ```
  55
  56 Capabilities
  57 ============
  58
  59 To configure dabba to run with a regular user account:
  60 ```sh
  61 $ sudo make setcap
  62 ```
  63
  64 Getting started!
  65 ================
  66
  67 Start dabbad:
  68 ```sh
  69 $ dabbad --daemonize
  70 ```
  71
  72 As long as dabbad is running, captures tasks can be submitted:
  73 ```sh
  74 $ dabba capture start --interface eth0 --pcap /tmp/example.pcap
  75 ```
  76
  77 Running captures can be listed in YAML format:
  78 ```sh
  79 $ dabba capture list
  80 ---
  81   captures:
  82     - id: 3076324160
  83       packet mmap size: 32768
  84       frame number: 16
  85       pcap: /tmp/example.pcap
  86       interface: eth0
  87 ```
  88
  89 Stopping the capture:
  90         $ dabba capture stop --id 3076324160
  91
  92 More info
  93 =========
  94
  95 Further information can be found on the project's [wiki](https://github.com/eroullit/dabba/wiki)
  96
  97 Copyright
  98 =========
  99
 100 Copyright (C) 2011-2012 Emmanuel Roullit <emmanuel.roullit@gmail.com>
 101
 102 This program is free software; you can redistribute it and/or modify
 103 it under the terms of the GNU General Public License as published by
 104 the Free Software Foundation; either version 2 of the License, or (at
 105 your option) any later version.
 106
 107 This program is distributed in the hope that it will be useful, but
 108 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 109 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 110 for more details.
 111
 112 You should have received a copy of the GNU General Public License along
 113 with this program; if not, write to the Free Software Foundation, Inc.,
 114 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 115
 116 Contact
 117 =======
 118
 119 For questions:
 120     Send me a message to @eroullit on GitHub
 121
 122 For suggestions or bug reports:
 123     Feel free to open an issue on the [ticket system](https://github.com/eroullit/dabba/issues).