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.

69 lines
3.2 KiB

6 years ago
  1. # Netify Agent
  2. Copyright ©2015-2020 eGloo Incorporated ([www.egloo.ca](https://www.egloo.ca))
  3. ## Network Intelligence - Simplified
  4. 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.
  5. 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.
  6. ## Download Packages
  7. Supported platforms with installation instructions can be found [here](https://www.netify.ai/get-netify).
  8. Alternatively, binary packages are available for the following OS distributions (manual install):
  9. - [CentOS](http://download.netify.ai/netify/centos/)
  10. - [ClearOS](http://download.netify.ai/netify/clearos/)
  11. - [Debian](http://download.netify.ai/netify/debian/)
  12. - [FreeBSD](http://download.netify.ai/netify/freebsd/)
  13. - [NethServer](http://download.netify.ai/netify/nethserver/)
  14. - [OpenWrt/LEDE](https://downloads.openwrt.org/snapshots/packages/)
  15. - [pfSense](http://download.netify.ai/netify/pfsense/)
  16. - [Raspbian](https://software.opensuse.org//download.html?project=home%3Aegloo&package=netifyd)
  17. - [RHEL](http://download.netify.ai/netify/rhel/)
  18. - [Ubuntu](http://download.netify.ai/netify/ubuntu/)
  19. ### Runtime Requirements
  20. - [Linux] Ensure that the nfnetlink and nf_conntrack_netlink kernel modules are loaded if NAT detection is enabled.
  21. ## Download Source
  22. When cloning the source tree, ensure you use `--recursive` to include all
  23. sub-modules.
  24. ### Build Requirements
  25. Netify requires the following third-party packages:
  26. - libcurl
  27. - libpcap
  28. - zlib
  29. - [Linux] libmnl
  30. - [Linux] libnetfilter-conntrack
  31. Optional:
  32. - google-perftools/gperftools/libtcmalloc (will use bundled version when not available)
  33. ### Configuring/Building From Source
  34. Read the appropriate documentation in the doc directory, prefixed with: `BUILD-*`
  35. Generally the process is:
  36. ```sh
  37. ./autogen.sh
  38. ./configure
  39. make
  40. ```
  41. ## Online Documentation
  42. Further user and developer documentation can be found [here](https://www.netify.ai/resources).
  43. ## License
  44. This software is licenced under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.txt):
  45. >>>
  46. Copyright (C) 2015-2020 eGloo Incorporated
  47. This program is free software: you can redistribute it and/or modify
  48. it under the terms of the GNU General Public License as published by
  49. the Free Software Foundation, either version 3 of the License, or
  50. (at your option) any later version.
  51. This program is distributed in the hope that it will be useful,
  52. but WITHOUT ANY WARRANTY; without even the implied warranty of
  53. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  54. GNU General Public License for more details.
  55. >>>