net/netifyd/README.md

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