README

   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 There's a public Git repository at http://github.com/eroullit/dabba
  25 where you can check out the latest code base.
  26
  27 git clone git://github.com/eroullit/dabba.git
  28
  29 Contributions are welcome, CODING regroups all information about it.
  30
  31 Prerequisites
  32 =============
  33
  34 dabba needs these to compile and run properly:
  35         - Linux kernel >= 2.6.31
  36         - cmake
  37         - pthread
  38         - setcap (within libcap package)
  39
  40 Recommended optional packages:
  41         - python-yaml
  42         - doxygen
  43
  44 Installation
  45 ============
  46
  47 To build out-of-tree:
  48         $ mkdir build && cd build && cmake .. && make
  49
  50 To install it after being built:
  51         $ sudo make install/strip
  52
  53 Capabilities
  54 ============
  55
  56 To configure dabba to run with a regular user account:
  57         $ sudo make setcap
  58
  59 Getting started!
  60 ================
  61
  62 Start dabbad:
  63         $ dabbad --daemonize
  64
  65 As long as dabbad is running, captures tasks can be submitted:
  66         $ dabba capture start --interface eth0 --pcap /tmp/example.pcap
  67
  68 Running captures can be listed in YAML format:
  69         $ dabba capture list
  70         ---
  71           captures:
  72             - id: 3076324160
  73               packet mmap size: 32768
  74               frame number: 16
  75               pcap: /tmp/example.pcap
  76               interface: eth0
  77
  78 Stopping the capture:
  79         $ dabba capture stop --id 3076324160
  80
  81 More info
  82 =========
  83
  84 Further information can be found on the project's wiki:
  85 https://github.com/eroullit/dabba/wiki
  86
  87 Copyright
  88 =========
  89
  90 Copyright (C) 2011-2012 Emmanuel Roullit <emmanuel.roullit@gmail.com>
  91
  92 This program is free software; you can redistribute it and/or modify
  93 it under the terms of the GNU General Public License as published by
  94 the Free Software Foundation; either version 2 of the License, or (at
  95 your option) any later version.
  96
  97 This program is distributed in the hope that it will be useful, but
  98 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  99 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 100 for more details.
 101
 102 You should have received a copy of the GNU General Public License along
 103 with this program; if not, write to the Free Software Foundation, Inc.,
 104 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 105
 106 Contact
 107 =======
 108
 109 For questions:
 110     Send me a message to @eroullit on GitHub
 111
 112 For suggestions or bug reports:
 113     https://github.com/eroullit/dabba and feel free to open an issue.