Skip to content

Commit 7f6d32c

Browse files
hynekkarhynekkar
authored
Merge pull request #234 from CESNET/docs_web_revision
docs: revision of web page (how to and installation pages)
2 parents 5ebd4b6 + 6cd01c3 commit 7f6d32c

File tree

6 files changed

+67
-38
lines changed

6 files changed

+67
-38
lines changed

‎docs/_data/navigation.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- name: "Get Ipfixprobe"
1+
- name: "Installation"
22
link: /get_options/
33
new_window: false
44
highlight: false
@@ -13,4 +13,4 @@
1313
- name: "Export Data"
1414
link: /export/
1515
new_window: false
16-
highlight: false
16+
highlight: false

‎docs/_get_options/a_rhel_packages.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
title: Get ipfixprobe from repository!
3-
description: We use COPR infrastructure to build and serve ipfixprobe packages. Currently, we generate RPM packages for RHEL-based distributions
2+
title: Installation from binary packages (RPM) (recommended)
3+
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.
44

55
instructions:
66
-
77
description: "Install copr repository."
88
code:
9-
- "dnf install -y dnf-plugins-core && dnf copr -y enable @CESNET/NEMEA"
9+
- "dnf install -y dnf-plugins-core && dnf copr -y enable @CESNET/NEMEA-stable"
1010

1111
-
1212
description: "After succesfull instalation of COPR, you can install the ipfixprobe via yum or dnf."
1313
code:
1414
- "dnf install ipfixprobe"
1515

1616

17-
---
17+
---

‎docs/_get_options/build_from_source.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Build ipfixprobe from source!
2+
title: Build from source codes
33
description: You can build ipfixprobe from source codes available at <a href="https://github.com/CESNET/ipfixprobe">github</a>.
44

55
instructions:
66
-
77
description: "Install requirements"
88
code:
9-
- "yum -y install wget curl net-tools gcc gcc-c++ git libtool libpcap-devel libunwind libssl-devel libpcap-devel"
9+
- "dnf -y install wget curl net-tools gcc gcc-c++ git libtool libpcap-devel libunwind libssl-devel libpcap-devel"
1010
-
1111
description: "Now get the ipfixprobe source codes"
1212
code:
@@ -30,4 +30,4 @@ instructions:
3030
- "./configure.sh --with-pcap --with-quic --with-unwind --with-nemea"
3131
- "make -j 2"
3232
- sudo make install
33-
---
33+
---

‎docs/_get_options/openwrt.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Installation on Turris (OpenWrt routers)
3+
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.
4+
5+
instructions:
6+
-
7+
description: "Update repository metadata"
8+
code:
9+
- opkg update
10+
11+
-
12+
description: "Install ipfixprobe"
13+
code:
14+
- opkg install ipfixprobe
15+
16+
-
17+
description: "Optionally for LUCI configuration page, install luci-app-ipfixprobe"
18+
code:
19+
- opkg install luci-app-ipfixprobe
20+
21+
22+
---
23+

‎docs/get_options.html‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Get ipfixprobe
3-
heading: Start using ipfixprobe
2+
title: Installation of ipfixprobe
3+
heading: How to install ipfixprobe?
44
---
55

66
{% for option in site.get_options %}
@@ -20,10 +20,11 @@ <h2 style="float:'left'">{{ option.title }}</h3>
2020
{% endfor %}
2121
</span>
2222
{% endfor %}
23-
24-
2523
{% endif %}
2624
</div>
2725
<hr>
2826
</section>
2927
{% endfor %}
28+
<section>
29+
Continue reading with <a href="{% link how.html %}">"How to use it"</a>...
30+
</section>

‎docs/how.html‎

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,33 @@
55

66
<section style="padding:0px; padding-bottom:100px">
77
<div class="container">
8+
This guide expects ipfixprobe is already installed, see <a href="{% link get_options.html %}">installation step</a>.
9+
10+
The following sections describe alternative ways how to run ipfixprobe.
11+
812
<div class="blog-post text-container">
13+
<hr class="not-hidden">
14+
<h1 class = "clickable">Systemd service (recommended)</h1>
15+
<p>The ipfixprobe can be set up to be used as a daemon to continuously process incoming packets from the boot up:</p>
16+
<p>Create your <b>instance.conf</b> configuration, and save it in <b>/etc/ipfixprobe/</b><br>
17+
18+
<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>
19+
20+
<p>To start the systemd service, use:</p>
21+
<span>
22+
<p style = "font-family: monospace;">sudo systemctl start [email protected]</p>
23+
</span>
24+
25+
<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>
26+
27+
<p>To enable the service at system startup, run:</p>
28+
<span>
29+
<p style = "font-family: monospace;">sudo systemctl enable [email protected]</p>
30+
</span>
31+
32+
<hr class="not-hidden">
33+
34+
<h1 class = "clickable">Command line &mdash; starting manually</h1>
935
<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>
1036
<div class="text editable">
1137
<span>
@@ -14,8 +40,6 @@
1440
<h1 style="float:'left'"><strong>{{ plugin.title | raw }}</strong></h1>
1541
<p>{{ plugin.description | raw }}</p>
1642
</div>
17-
<hr class="not-hidden">
18-
<h1 class = "clickable" >Command line</h1>
1943
<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>
2044
{% for plugin in site.how %}
2145
<div class="text editable">
@@ -43,6 +67,7 @@ <h4> {{ option.title }}</h4>
4367
{% endfor %}
4468
{% endfor %}
4569
{% endfor %}
70+
4671
<hr class="not-hidden">
4772
<h1 class = "clickable" >One-time convertion of PCAP file to CSV</h1>
4873
<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>
84109
<span>
85110
<p style = "font-family: monospace;">bash ./ipfixprobe_wrapper.sh ./process_script.sh ../pcaps/mixed.pcap ./output.csv</p>
86111
</span>
112+
87113
<hr class="not-hidden">
88-
<h1 class = "clickable">ipfixprobe as a service</h1>
89-
<p>The ipfxprobe can be set up to be used as a daemon to continuously process incoming packets from the boot up:</p>
90-
<h2>On linux server</h2>
91-
<p>Install the ipfixprobe:</p>
92-
<span>
93-
<p style = "font-family: monospace;">sudo make install</p>
94-
</span>
95-
<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>
96-
Prepare the service configuration file:</p>
97-
<span>
98-
<p style = "font-family: monospace;">sudo mv init/[email protected] /etc/systemd/system/[email protected]</p>
99-
</span>
100-
<p>Set up the <b>ExecStart</b> from <b>[email protected]</b> to point to the <b>ipfixprobed</b> script.</p>
101-
<p>To start the service use:</p>
102-
<span>
103-
<p style = "font-family: monospace;">sudo systemctl start [email protected]</p>
104-
</span>
105-
<p>To start the service at system startup, run:</p>
106-
<span>
107-
<p style = "font-family: monospace;">sudo systemctl enable [email protected]</p>
108-
</span>
109-
<h2>OpenWRT</h2>
114+
<h1 class = "clickable">OpenWrt / Turris</h1>
110115
<p>Create and save the configuration file to the <b>/etc/config/ipfixprobe</b>. Example of configuration file:<br></p>
111116
<span>
112117
<p style = "font-family: monospace; white-space: pre-line;"> NEMEA ipfixprobe
@@ -203,4 +208,4 @@ <h2>OpenWRT</h2>
203208
});
204209
hideAll();
205210
});
206-
</script>
211+
</script>

0 commit comments

Comments
 (0)