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. supplied PDF manpages. They were built with:
  10. man -t ./softflowd.8 | ps2pdf - softflowd.pdf
  11. man -t ./softflowctl.8 | ps2pdf - softflowctl.pdf
  12. You can view those pages prior to installation using:
  13. /usr/bin/nroff -c -mandoc softflowd.8 | less
  14. /usr/bin/nroff -c -mandoc softflowctl.8 | less
  15. If you are in need of a NetFlow collector, you may be interested in
  16. softflowd's companion project "flowd" (
  17. flowd is a NetFlow collector that is maintained in parallel with
  18. softflowd and includes a few handy features, such as the ability
  19. to filter flows it receives as well as Perl and Python APIs to its
  20. storage format. NB. You don't have to use flowd: any NetFlow compatible
  21. collector should work with softflowd. An example Perl collector is included
  22. for testing purposes as, but it doesn't yet support NetFlow v.9
  23. Installing
  24. ----------
  25. Building softflowd should be as simple as typing:
  26. autoconf
  27. autoreconf
  28. ./configure
  29. make
  30. make install
  31. Unfortunately some systems like to make life complicated. Things work
  32. fine on the systems that I develop and test on (OpenBSD and Linux).
  33. There is peliminary support for Solaris 9 (i.e. it compiled), but no
  34. testing on this platform has been performed.
  35. Licensing
  36. ---------
  37. Softflowd is licensed under a two-term BSD license (see the source
  38. files for details). The code in sys-tree.h is Copyright Niels Provos
  39. <> and comes straight from OpenBSD CVS, convtime.c
  40. comes is Copyright Kevin Steves and comes from OpenSSH (misc.c). Both
  41. of these files are licensed under two-term BSD licenses too. strlcpy.c,
  42. strlcat.c and closefrom.c also come from OpenBSD CVS and are Copyright
  43. Todd C. Miller. Please refer to the LICENSE file for full details.
  44. Reporting Bugs
  45. --------------
  46. Please report bugs in softflowd (
  47. to
  48. Following descriptions are historical information:
  49. Please report bugs in softflowd to If you
  50. find a security bug, please report it directly by email. If you have any
  51. feedback or questions, please email me:
  52. Contributing
  53. ------------
  54. Softflowd has an extensive TODO list of interesting features, large and
  55. small, that are waiting to be implemented. If you are interested in
  56. helping, please contact me.
  57. The latest source code may be obtained from Github:
  59. (This repository was forked from
  60. Original creator:
  61. Damien Miller <>
  62. Current maintainer:
  63. Hitoshi Irino <>