You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

77 lines
2.8 KiB

6 years ago
6 years ago
6 years ago
6 years ago
  1. Netify Agent
  2. ============
  3. Copyright ©2015-2019 eGloo Incorporated ([www.egloo.ca](https://www.egloo.ca))
  4. Network Intelligence - Simplified
  5. ---------------------------------
  6. The [Netify Agent](https://www.netify.ai/) is a deep-packet inspection server. The Agent is built on top of [nDPI](http://www.ntop.org/products/deep-packet-inspection/ndpi/) (formerly OpenDPI) to detect network protocols and applications. Detections can be saved locally, served over a UNIX or TCP socket, and/or "pushed" (via HTTP POSTs) to a remote third-party server. Flow metadata, network statistics, and detection classifications are stored using JSON encoding.
  7. Optionally, the Netify Agent can be coupled with a [Netify Cloud](https://www.netify.ai/) subscription for further cloud processing, historical storage, machine-learning analysis, event notifications, device detection/identification, along with the option (on supported platforms) to take an active role in policing/bandwidth-shaping specific network protocols and applications.
  8. Runtime Requirements
  9. --------------------
  10. Ensure that the nfnetlink and nf_conntrack_netlink kernel modules are loaded.
  11. Build Requirements
  12. ------------------
  13. Netify requires the following third-party packages:
  14. - libcurl
  15. - libjson-c
  16. - libmnl
  17. - libnetfilter-conntrack
  18. - libpcap
  19. - zlib
  20. Optional:
  21. - libtcmalloc (gperftools)
  22. Download Source
  23. ---------------
  24. When cloning the source tree, ensure you use `--recursive` to include all
  25. sub-modules.
  26. Download Packages
  27. -----------------
  28. Currently you can download binary packages for the following OS distributions:
  29. - [ClearOS](https://www.clearos.com/products/purchase/clearos-marketplace-apps#cloud)
  30. - [CentOS](http://software.opensuse.org/download.html?project=home%3Aegloo&package=netifyd)
  31. - [Debian](http://software.opensuse.org/download.html?project=home%3Aegloo&package=netifyd)
  32. - [Fedora](http://software.opensuse.org/download.html?project=home%3Aegloo&package=netifyd)
  33. - [Ubuntu](http://software.opensuse.org/download.html?project=home%3Aegloo&package=netifyd)
  34. Developer Documentation
  35. -----------------------
  36. Further developer documentation can be found [here](https://www.netify.ai/developer/netify-agent).
  37. Configuring/Building From Source
  38. --------------------------------
  39. Read the appropriate documentation in the doc directory, prefixed with: BUILD-*
  40. Generally the process is:
  41. ```
  42. # ./autogen.sh
  43. # ./configure
  44. # make
  45. ```
  46. License
  47. -------
  48. ```
  49. This program is free software: you can redistribute it and/or modify
  50. it under the terms of the GNU General Public License as published by
  51. the Free Software Foundation, either version 3 of the License, or
  52. (at your option) any later version.
  53. This program is distributed in the hope that it will be useful,
  54. but WITHOUT ANY WARRANTY; without even the implied warranty of
  55. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  56. GNU General Public License for more details.
  57. ```