1. Welcome to softflowd, a flow-based network monitor.
  2. Introduction
  3. ------------
  4. softflowd listens promiscuously on a network interface and semi-statefully
  5. tracks network flows. These flows can be reported using NetFlow version 1, 5
  6. or 9 datagrams. softflowd is fully IPv6 capable: it can track IPv6 flows and
  7. export to IPv6 hosts.
  8. More details about softflowd's function and usage may be found in the
  9. softflowd wiki in following URLs:
  12. PDF manpages can be built with:
  13. man -t ./softflowd.8 | ps2pdf - softflowd.pdf
  14. man -t ./softflowctl.8 | ps2pdf - softflowctl.pdf
  15. HTML manpages can be built with:
  16. groff -mandoc -Thtml softflowd.8 > softflowd.html
  17. groff -mandoc -Thtml softflowctl.8 > softflowctl.html
  18. Markdown manpages (which are published in wiki pages) can be built
  19. from above HtML manpages:
  20. pandoc -s softflowd.html -o
  21. pandoc -s softflowctl.html -o
  22. You can view those pages prior to installation using:
  23. /usr/bin/nroff -c -mandoc softflowd.8 | less
  24. /usr/bin/nroff -c -mandoc softflowctl.8 | less
  25. If you are in need of a NetFlow collector, you may be interested in
  26. softflowd's companion project "flowd" (
  27. flowd is a NetFlow collector that is maintained in parallel with
  28. softflowd and includes a few handy features, such as the ability
  29. to filter flows it receives as well as Perl and Python APIs to its
  30. storage format. NB. You don't have to use flowd: any NetFlow compatible
  31. collector should work with softflowd. An example Perl collector is included
  32. for testing purposes as, but it doesn't yet support NetFlow v.9
  33. Installing
  34. ----------
  35. Building softflowd should be as simple as typing:
  36. autoreconf -if # instead of "aclocal && autoheader && automake --add-missing && autoconf"
  37. ./configure
  38. make
  39. make install
  40. Unfortunately some systems like to make life complicated. Things work
  41. fine on the systems that I develop and test on (OpenBSD and Linux).
  42. There is peliminary support for Solaris 9 (i.e. it compiled), but no
  43. testing on this platform has been performed.
  44. Licensing
  45. ---------
  46. Softflowd is licensed under a two-term BSD license (see the source
  47. files for details). The code in sys-tree.h is Copyright Niels Provos
  48. <> and comes straight from OpenBSD CVS, convtime.c
  49. comes is Copyright Kevin Steves and comes from OpenSSH (misc.c). Both
  50. of these files are licensed under two-term BSD licenses too. strlcpy.c,
  51. strlcat.c and closefrom.c also come from OpenBSD CVS and are Copyright
  52. Todd C. Miller. Please refer to the LICENSE file for full details.
  53. Reporting Bugs
  54. --------------
  55. Please report bugs in softflowd (
  56. to
  57. Following descriptions are historical information:
  58. Please report bugs in softflowd to If you
  59. find a security bug, please report it directly by email. If you have any
  60. feedback or questions, please email me:
  61. Contributing
  62. ------------
  63. Softflowd has an extensive TODO list of interesting features, large and
  64. small, that are waiting to be implemented. If you are interested in
  65. helping, please contact me.
  66. The latest source code may be obtained from Github:
  68. (This repository was forked from
  69. Original creator:
  70. Damien Miller <>
  71. Current maintainer:
  72. Hitoshi Irino <>