CESNET · hynekkar · Nov 20, 2024 · Nov 20, 2024
diff --git 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
+  highlight: false
diff --git a/docs/_get_options/a_rhel_packages.md b/docs/_get_options/a_rhel_packages.md
@@ -1,17 +1,17 @@
 ---
-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 <a href="https://copr.fedorainfracloud.org/coprs/g/CESNET/NEMEA-stable/">COPR infrastructure</a> 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."
        code: 
         - "dnf install ipfixprobe"
 
 
----
+---
diff --git 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 <a href="https://github.com/CESNET/ipfixprobe">github</a>. 
 
 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
----
+---
diff --git a/docs/_get_options/openwrt.md 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 <a href="">NEMEA-OpenWrt feed</a> 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
@@ -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 @@ <h2 style="float:'left'">{{ option.title }}</h3>
         {% endfor %}
       </span>
       {% endfor %}
-
-
     {% endif %}
   </div>
   <hr>
 </section>
 {% endfor %}
+<section>
+Continue reading with <a href="{% link how.html %}">"How to use it"</a>...
+</section>
diff --git a/docs/how.html b/docs/how.html
@@ -5,7 +5,33 @@
 
 <section style="padding:0px; padding-bottom:100px">
 <div class="container">	
+	This guide expects ipfixprobe is already installed, see <a href="{% link get_options.html %}">installation step</a>.
+
+	The following sections describe alternative ways how to run ipfixprobe.
+
 	<div class="blog-post text-container">
+		<hr class="not-hidden">
+		<h1 class = "clickable">Systemd service (recommended)</h1>
+		<p>The ipfixprobe can be set up to be used as a daemon to continuously process incoming packets from the boot up:</p>
+		<p>Create your <b>instance.conf</b> configuration, and save it in <b>/etc/ipfixprobe/</b><br>
+
+		<span style="background-color: #ffe59e; " >All settings are explained in the <a href="https://github.com/CESNET/ipfixprobe/blob/master/init/link0.conf.example">example file</a></span>
+
+		<p>To start the systemd service, use:</p>
+		<span>
+			<p style = "font-family: monospace;">sudo systemctl start ipfixprobe@instance.service</p>
+		</span>
+
+		<span style="background-color: #ffe59e; " >"instance" serves as Your identifier of ipfixprobe instance, it must be equal in the name of the configuration file and in the systemctl command.</span>
+
+		<p>To enable the service at system startup, run:</p>
+		<span>
+			<p style = "font-family: monospace;">sudo systemctl enable ipfixprobe@instance.service</p>
+		</span>
+
+		<hr class="not-hidden">
+
+		<h1 class = "clickable">Command line &mdash; starting manually</h1>
 		<p>The simplest way to use ipfixprobe is to process PCAP file using PCAP plugin (need to be <b>./configure</b>d with --with-pcap) </p>
 		<div class="text editable">
 			<span>
@@ -14,8 +40,6 @@
 			<h1 style="float:'left'"><strong>{{ plugin.title | raw }}</strong></h1>
 			<p>{{ plugin.description | raw }}</p>
 			</div>
-		<hr class="not-hidden">
-		<h1 class = "clickable" >Command line</h1>
 		<p>The ipfixprobe consists of one <b>input</b>, zero or one <b>output</b>, one <b>storage</b> and zero or more <b>process</b> plugins.	</p>
 		{% for plugin in site.how  %}
 			<div class="text editable">
@@ -43,6 +67,7 @@ <h4> {{ option.title }}</h4>
 				{% endfor %}
 			{% endfor %}
 		{% endfor %}
+
 		<hr class="not-hidden">
 		<h1 class = "clickable" >One-time convertion of PCAP file to CSV</h1>
 		<p>The ipfixprobe can be used to convert given PCAP file to the CSV containing flows from that file in the Unirec format.</p>
@@ -84,29 +109,9 @@ <h4>Run</h4>
 		<span>
 			<p style = "font-family: monospace;">bash ./ipfixprobe_wrapper.sh ./process_script.sh ../pcaps/mixed.pcap ./output.csv</p>
 		</span>
+
 		<hr class="not-hidden">
-		<h1 class = "clickable">ipfixprobe as a service</h1>
-		<p>The ipfxprobe can be set up to be used as a daemon to continuously process incoming packets from the boot up:</p>
-		<h2>On linux server</h2>
-		<p>Install the ipfixprobe:</p>
-		<span>
-			<p style = "font-family: monospace;">sudo make install</p>
-		</span>
-		<p>Create your <b>instance.conf</b> configuration inspired by example configurations from the <b>init</b> directory and save it into the <b>/etc/ipfixprobe/</b><br>
-		Prepare the service configuration file:</p>
-		<span>
-			<p style = "font-family: monospace;">sudo mv init/ipfixprobe@.service /etc/systemd/system/ipfixprobe@instance.service</p>
-		</span>
-		<p>Set up the <b>ExecStart</b> from <b>ipfixprobe@instance.service</b> to point to the <b>ipfixprobed</b> script.</p>
-		<p>To start the service use:</p>
-		<span>
-			<p style = "font-family: monospace;">sudo systemctl start ipfixprobe@instance.service</p>
-		</span>
-		<p>To start the service at system startup, run:</p>
-		<span>
-			<p style = "font-family: monospace;">sudo systemctl enable ipfixprobe@instance.service</p>
-		</span>
-		<h2>OpenWRT</h2>
+		<h1 class = "clickable">OpenWrt / Turris</h1>
 		<p>Create and save the configuration file to the <b>/etc/config/ipfixprobe</b>. Example of configuration file:<br></p>
 		<span>
 			<p style = "font-family: monospace; white-space: pre-line;"> NEMEA ipfixprobe
@@ -203,4 +208,4 @@ <h2>OpenWRT</h2>
   });
   hideAll();
 });
-</script>
+</script>