From 6cd01c303b3c37c2fe96d36de19f2cbd307256f0 Mon Sep 17 00:00:00 2001 From: Tomas Cejka Date: Wed, 20 Nov 2024 15:10:57 +0100 Subject: [PATCH] docs: revision of web page --- docs/_data/navigation.yml | 4 +- docs/_get_options/a_rhel_packages.md | 8 ++-- docs/_get_options/build_from_source.md | 6 +-- docs/_get_options/openwrt.md | 23 +++++++++++ docs/get_options.html | 9 +++-- docs/how.html | 55 ++++++++++++++------------ 6 files changed, 67 insertions(+), 38 deletions(-) create mode 100644 docs/_get_options/openwrt.md diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 3de742710..3535d2c68 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -1,4 +1,4 @@ -- name: "Get Ipfixprobe" +- name: "Installation" link: /get_options/ new_window: false highlight: false @@ -13,4 +13,4 @@ - name: "Export Data" link: /export/ new_window: false - highlight: false \ No newline at end of file + highlight: false diff --git a/docs/_get_options/a_rhel_packages.md b/docs/_get_options/a_rhel_packages.md index 5a8dec4bf..c67cf60be 100644 --- a/docs/_get_options/a_rhel_packages.md +++ b/docs/_get_options/a_rhel_packages.md @@ -1,12 +1,12 @@ --- -title: Get ipfixprobe from repository! -description: We use COPR infrastructure to build and serve ipfixprobe packages. Currently, we generate RPM packages for RHEL-based distributions +title: Installation from binary packages (RPM) (recommended) +description: We use COPR infrastructure to build and serve ipfixprobe packages. Currently, we support packages for RPM-based distributions, such as OracleLinux, RockyLinux, ... EPEL version 8 or 9. instructions: - description: "Install copr repository." code: - - "dnf install -y dnf-plugins-core && dnf copr -y enable @CESNET/NEMEA" + - "dnf install -y dnf-plugins-core && dnf copr -y enable @CESNET/NEMEA-stable" - description: "After succesfull instalation of COPR, you can install the ipfixprobe via yum or dnf." @@ -14,4 +14,4 @@ instructions: - "dnf install ipfixprobe" ---- \ No newline at end of file +--- diff --git a/docs/_get_options/build_from_source.md b/docs/_get_options/build_from_source.md index 0c408d808..10ff2ae47 100644 --- a/docs/_get_options/build_from_source.md +++ b/docs/_get_options/build_from_source.md @@ -1,12 +1,12 @@ --- -title: Build ipfixprobe from source! +title: Build from source codes description: You can build ipfixprobe from source codes available at github. instructions: - description: "Install requirements" code: - - "yum -y install wget curl net-tools gcc gcc-c++ git libtool libpcap-devel libunwind libssl-devel libpcap-devel" + - "dnf -y install wget curl net-tools gcc gcc-c++ git libtool libpcap-devel libunwind libssl-devel libpcap-devel" - description: "Now get the ipfixprobe source codes" code: @@ -30,4 +30,4 @@ instructions: - "./configure.sh --with-pcap --with-quic --with-unwind --with-nemea" - "make -j 2" - sudo make install ---- \ No newline at end of file +--- diff --git a/docs/_get_options/openwrt.md b/docs/_get_options/openwrt.md new file mode 100644 index 000000000..66b92bf33 --- /dev/null +++ b/docs/_get_options/openwrt.md @@ -0,0 +1,23 @@ +--- +title: Installation on Turris (OpenWrt routers) +description: CESNET feed is officially supported by CZ.NIC, so installation on Turris devices is easy! Contrary for other OpenWrt devices, it is most likely necessary to compile a package; see our NEMEA-OpenWrt feed for more details or contact us. Installation on Turris can be done via SSH, which is described bellow, or using LUCI intuitive interface. + +instructions: + - + description: "Update repository metadata" + code: + - opkg update + + - + description: "Install ipfixprobe" + code: + - opkg install ipfixprobe + + - + description: "Optionally for LUCI configuration page, install luci-app-ipfixprobe" + code: + - opkg install luci-app-ipfixprobe + + +--- + diff --git a/docs/get_options.html b/docs/get_options.html index 34325c3dc..2336a7190 100644 --- a/docs/get_options.html +++ b/docs/get_options.html @@ -1,6 +1,6 @@ --- -title: Get ipfixprobe -heading: Start using ipfixprobe +title: Installation of ipfixprobe +heading: How to install ipfixprobe? --- {% for option in site.get_options %} @@ -20,10 +20,11 @@

{{ option.title }}

{% endfor %} {% endfor %} - - {% endif %}
{% endfor %} +
+Continue reading with "How to use it"... +
diff --git a/docs/how.html b/docs/how.html index 3dc1f72e0..7258b479f 100644 --- a/docs/how.html +++ b/docs/how.html @@ -5,7 +5,33 @@
+ This guide expects ipfixprobe is already installed, see installation step. + + The following sections describe alternative ways how to run ipfixprobe. +
+
+

Systemd service (recommended)

+

The ipfixprobe can be set up to be used as a daemon to continuously process incoming packets from the boot up:

+

Create your instance.conf configuration, and save it in /etc/ipfixprobe/
+ + All settings are explained in the example file + +

To start the systemd service, use:

+ +

sudo systemctl start ipfixprobe@instance.service

+ + + "instance" serves as Your identifier of ipfixprobe instance, it must be equal in the name of the configuration file and in the systemctl command. + +

To enable the service at system startup, run:

+ +

sudo systemctl enable ipfixprobe@instance.service

+ + +
+ +

Command line — starting manually

The simplest way to use ipfixprobe is to process PCAP file using PCAP plugin (need to be ./configured with --with-pcap)

@@ -14,8 +40,6 @@

{{ plugin.title | raw }}

{{ plugin.description | raw }}

-
-

Command line

The ipfixprobe consists of one input, zero or one output, one storage and zero or more process plugins.

{% for plugin in site.how %}
@@ -43,6 +67,7 @@

{{ option.title }}

{% endfor %} {% endfor %} {% endfor %} +

One-time convertion of PCAP file to CSV

The ipfixprobe can be used to convert given PCAP file to the CSV containing flows from that file in the Unirec format.

@@ -84,29 +109,9 @@

Run

bash ./ipfixprobe_wrapper.sh ./process_script.sh ../pcaps/mixed.pcap ./output.csv

 +
-

ipfixprobe as a service

-

The ipfxprobe can be set up to be used as a daemon to continuously process incoming packets from the boot up:

-

On linux server

-

Install the ipfixprobe:

- -

sudo make install

- -

Create your instance.conf configuration inspired by example configurations from the init directory and save it into the /etc/ipfixprobe/
- Prepare the service configuration file:

- -

sudo mv init/ipfixprobe@.service /etc/systemd/system/ipfixprobe@instance.service

- -

Set up the ExecStart from ipfixprobe@instance.service to point to the ipfixprobed script.

-

To start the service use:

- -

sudo systemctl start ipfixprobe@instance.service

- -

To start the service at system startup, run:

- -

sudo systemctl enable ipfixprobe@instance.service

- -

OpenWRT

+

OpenWrt / Turris

Create and save the configuration file to the /etc/config/ipfixprobe. Example of configuration file:

NEMEA ipfixprobe @@ -203,4 +208,4 @@

OpenWRT

}); hideAll(); }); - \ No newline at end of file +