├── LICENSE ├── README.md ├── docker-compose.yaml ├── nfdump ├── Dockerfile └── entrypoint.sh ├── nfsen-ng ├── Dockerfile ├── entrypoint.sh └── settings.php └── sources.conf /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # nfsen-ng-docker 2 | 3 | Docker setup for running nfsen-ng (Netflow visualizer) and nfdump (Netflow/Sflow collector) together with support for mutiple sources. 4 | 5 | ## Installation 6 | 7 | 1. git pull https://github.com/dircr/nfsen-ng-docker.git 8 | 2. verify ports and paths in docker-compose.yaml 9 | 10 | ## Usage 11 | 12 | 1. fill source.conf 13 | - csv style file with format : "device;port;proto" 14 | - where: 15 | - device is a display name like 'my-awesome-router' 16 | - port is a uniq value in-between 9000-9099 17 | - proto is sflow or nflow depending on your device capabilities) 18 | 2. docker-compose up -d 19 | 3. browse to http://localhost:81 20 | 21 | => additonally, you may add/remove lines in sources.conf... you need then to restart the stack by issuing 'docker-compose restart' 22 | 23 | ## Tested with: 24 | - Arista EOS 4.23.3M (in Jan 2021) 25 | - Ubiquiti EdgeRouter™ X 26 | 27 | ## An issue ? 28 | 29 | 1. clone 30 | 2. correct 31 | 3. share 32 | -------------------------------------------------------------------------------- /docker-compose.yaml: -------------------------------------------------------------------------------- 1 | version: '2' 2 | 3 | services: 4 | 5 | nfsen: 6 | build: nfsen-ng 7 | ports: 8 | - 81:80 9 | volumes: 10 | - ./profiles-data:/var/nfdump/profiles-data 11 | - ./sources.conf:/tmp/sources.conf:ro 12 | restart: unless-stopped 13 | 14 | nfdump: 15 | build: nfdump 16 | ports: 17 | - 9000-9099:9000-9099/udp 18 | volumes: 19 | - ./profiles-data:/data 20 | - ./sources.conf:/tmp/sources.conf:ro 21 | restart: unless-stopped 22 | -------------------------------------------------------------------------------- /nfdump/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM debian:10 2 | 3 | RUN apt update \ 4 | && apt install -y nfdump \ 5 | && apt-get install -y nfdump-sflow \ 6 | && apt install -y procps 7 | 8 | WORKDIR /app 9 | COPY entrypoint.sh . 10 | RUN chmod a+x /app/entrypoint.sh 11 | 12 | ENTRYPOINT [ "/bin/bash", "/app/entrypoint.sh" ] 13 | -------------------------------------------------------------------------------- /nfdump/entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # avoid process container restart when updating sources.conf 3 | cp /tmp/sources.conf /tmp/sources.set 4 | # read source.set and start a background [sn]fcap process for each source 5 | cat /tmp/sources.set | while read ln; do 6 | command="" 7 | read -r host port protocol <<< $(echo $ln | awk -F ';' '{print $1 " " $2 " " substr($3,1,1)}') 8 | mkdir -p /data/live/$host && command="${protocol}fcapd -I $host -l /data/live/$host -w -S 1 -T all -p $port" 9 | if [ -z "$command" ]; then 10 | echo >&2 "Error creating directory /data/live/$host" 11 | exit 1 12 | else 13 | echo '$' $command 14 | $command & 15 | sleep 0.1 16 | fi 17 | if [ $? -ne 0 ]; then 18 | echo >&2 "Startup interrupted !" 19 | exit 20 | fi 21 | done 22 | sleep 1 23 | echo "Ready" 24 | while true; do 25 | sleep 60; 26 | cat /tmp/sources.set | while read ln; do 27 | read -r host port protocol <<< $(echo $ln | awk -F ';' '{print $1 " " $2 " " substr($3,1,1)}') 28 | command="${protocol}fcapd -I $host -l /data/live/$host -w -S 1 -T all -p $port" 29 | ps aux| grep '\s'$host'\s' > /dev/null || { echo >&2 "Missing process for $host (port $port)"; exit 1; } 30 | done 31 | if [ $? -ne 0 ]; then 32 | echo >&2 "Restarting..." 33 | break 34 | fi 35 | done 36 | -------------------------------------------------------------------------------- /nfsen-ng/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM php:7.4-apache 2 | 3 | MAINTAINER Konrad Roziewski 4 | 5 | WORKDIR /var/www/html 6 | RUN DEBIAN_FRONTEND=noninteractive apt update && apt install -y pkg-config nfdump rrdtool librrd-dev git 7 | RUN a2enmod rewrite deflate headers expires 8 | RUN pecl install rrd 9 | RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini" 10 | RUN echo "extension=rrd.so" >> /usr/local/etc/php/conf.d/rrd.ini 11 | RUN sed -e '//,/<\/Directory>/s/AllowOverride None/AllowOverride All/' -i /etc/apache2/apache2.conf 12 | 13 | RUN git clone https://github.com/mbolli/nfsen-ng.git . 14 | COPY settings.php backend/settings/settings.tmpl 15 | COPY entrypoint.sh /tmp/ 16 | 17 | RUN chown -R www-data:www-data . 18 | RUN chmod +x backend/cli.php /tmp/entrypoint.sh 19 | 20 | ENV PROFILES_DATA_PATH /var/nfdump/profiles-data/ 21 | ENV APACHE_RUN_USER www-data 22 | ENV APACHE_RUN_GROUP www-data 23 | ENV APACHE_LOG_DIR /var/log/apache2 24 | ENV APACHE_PID_FILE /var/run/apache2.pid 25 | ENV APACHE_RUN_DIR /var/run/apache2 26 | ENV APACHE_LOCK_DIR /var/lock/apache2 27 | ENV APACHE_LOG_DIR /var/log/apache2 28 | 29 | VOLUME [ "/var/nfdump/profiles-data" ] 30 | 31 | EXPOSE 80 32 | 33 | ENTRYPOINT [ "/tmp/entrypoint.sh" ] 34 | -------------------------------------------------------------------------------- /nfsen-ng/entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | sources=`cat /tmp/sources.conf | sed -re "s/^([^;]*);.*$/'\1',/" | tr '\n' ' ' ` 3 | sed -e "s/'router',/$sources/" /var/www/html/backend/settings/settings.tmpl > /var/www/html/backend/settings/settings.php 4 | 5 | if php -f backend/settings/settings.php; then 6 | /var/www/html/backend/cli.php start 7 | apache2-foreground 8 | fi 9 | -------------------------------------------------------------------------------- /nfsen-ng/settings.php: -------------------------------------------------------------------------------- 1 | array( 12 | 'ports' => array( 13 | 80, 22, 53, 443 14 | ), 15 | 'sources' => array( 16 | 'router', // DO NOT ALTER THIS LINE, it will be modified by entrypoint.sh 17 | ), 18 | 'db' => 'RRD', 19 | 'processor' => 'NfDump', 20 | ), 21 | 'frontend' => array( 22 | 'reload_interval' => 60, 23 | 'defaults' => array( 24 | 'view' => 'graphs', // graphs, flows, statistics 25 | 'graphs' => array( 26 | 'display' => 'sources', // sources, protocols, ports 27 | 'datatype' => 'flows', // flows, packets, bytes 28 | 'protocols' => array('any'), // any, tcp, udp, icmp, others (multiple possible if display=protocols) 29 | ), 30 | 'flows' => array( 31 | 'limit' => 200, 32 | ), 33 | 'statistics' => array( 34 | 'order_by' => 'bytes', 35 | ), 36 | ), 37 | ), 38 | 'nfdump' => array( 39 | 'binary' => '/usr/bin/nfdump', 40 | 'profiles-data' => '/var/nfdump/profiles-data', 41 | 'profile' => 'live', 42 | 'max-processes' => 1, // maximum number of concurrently running nfdump processes 43 | ), 44 | 'db' => array( 45 | // 'Akumuli' => array( 46 | // //'host' => 'localhost', 47 | // //'port' => 8282, 48 | // ), 49 | 'RRD' => array() 50 | ), 51 | 'log' => array( 52 | 'priority' => LOG_INFO, // LOG_DEBUG is very talkative! 53 | ) 54 | ); 55 | -------------------------------------------------------------------------------- /sources.conf: -------------------------------------------------------------------------------- 1 | router1;9000;nflow 2 | router2;9001;sflow 3 | --------------------------------------------------------------------------------