Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
151 commits
Select commit Hold shift + click to select a range
2af9567
dpdk: reduce value of DEFAULT_MBUF_POOL_SIZE to use it also as rx que…
TheSableCZ Nov 12, 2024
70969e4
dpdkDevice: use mempool size as rx queue size instead of burst size
TheSableCZ Nov 12, 2024
f03a3a0
Merge pull request #230 from CESNET/dpdk-rx-queue-size-fix
SiskaPavel Nov 12, 2024
97cf479
ipfixprobe: increased version, updated ChangeLog, released RPM package
SiskaPavel Nov 14, 2024
6bd0a16
Merge pull request #231 from CESNET/new-version
SiskaPavel Nov 14, 2024
410124c
Introduce doc using Jekyll & Update README (#232)
hynekkar Nov 15, 2024
043a882
README: FIX ipfixprobe logo and link to documentation
hynekkar Nov 15, 2024
c719114
doc: FIX GitHub logo in footer
hynekkar Nov 15, 2024
5ebd4b6
Merge pull request #233 from CESNET/docFix
cejkato2 Nov 15, 2024
6cd01c3
docs: revision of web page
cejkato2 Nov 20, 2024
7f6d32c
Merge pull request #234 from CESNET/docs_web_revision
hynekkar Nov 20, 2024
6353b5d
docs: fix centering in the website footer
hynekkar Nov 25, 2024
70bee54
docs: fix jekyll base url and update docs description
hynekkar Nov 25, 2024
efac3ea
Merge pull request #235 from CESNET/doc_fix
cejkato2 Nov 25, 2024
28a1162
docs: fix jekyll links
hynekkar Nov 25, 2024
541af95
Merge pull request #236 from CESNET/doc_fix
hynekkar Nov 25, 2024
649ef2f
Readme - update telemetry docs
SiskaPavel Nov 26, 2024
6532d55
Merge pull request #237 from CESNET/telemetry-readme
cejkato2 Nov 28, 2024
f1877cb
ipfix-elements: fix NTP_USEC_TO_FRAC macro
TheSableCZ Dec 9, 2024
7ee2138
Merge pull request #241 from CESNET/fix-ipfix-ntp-conversion
SiskaPavel Dec 9, 2024
0a0dfc3
configure.ac - add checks for telemetry and appfs libraries
SiskaPavel Dec 16, 2024
762f872
README - update build requirements
SiskaPavel Dec 16, 2024
10fea0b
Merge pull request #242 from CESNET/telemetry-lib-check
SiskaPavel Dec 16, 2024
24ce625
dpdk: Add dpdkCompact - compatibility definitions for DPDK versions
SiskaPavel Dec 27, 2024
8d412de
dpdk: fix RSS configuration
SiskaPavel Dec 27, 2024
82958b1
Merge pull request #246 from CESNET/dpdk-rss
SiskaPavel Dec 27, 2024
174321f
dpdk: add compatible definition macro to dpdkCompact
SiskaPavel Dec 27, 2024
83da2eb
dpdk: add DPDK port telemetry
SiskaPavel Dec 27, 2024
ea733c6
dpdk: Add DPDK telemetry
SiskaPavel Dec 27, 2024
4f239ca
Merge pull request #247 from CESNET/dpdk-telemetry
SiskaPavel Dec 27, 2024
41eea65
ipfixprobe: increased version, updated ChangeLog, released RPM package
SiskaPavel Dec 27, 2024
39bb08e
Merge pull request #248 from CESNET/new-version
SiskaPavel Dec 27, 2024
355377d
dpdk: fix multiple dpdk telemetry files registration
SiskaPavel Jan 2, 2025
70e7cc2
Merge pull request #249 from CESNET/dpdk-telemetry
SiskaPavel Jan 10, 2025
4539997
Adjust flow interface
Zadamsa Oct 1, 2024
e8516c0
Adgust ProcessPlugin base class
Zadamsa Oct 1, 2024
ff8b3fc
Adjust StoragePlugin base class
Zadamsa Oct 1, 2024
66d0c9a
Adjust NHTFlowCache storage plugin
Zadamsa Oct 1, 2024
bf301c2
Adjust BasicPlus plugin
Zadamsa Oct 1, 2024
60eb043
Adjust DNSPlugin
Zadamsa Oct 1, 2024
0775187
Adjust FlexProbe-* plugins
Zadamsa Oct 1, 2024
46f0a0d
Adjust BSTATS plugin
Zadamsa Oct 1, 2024
1eccf52
Adjust DNSSD plugin
Zadamsa Oct 1, 2024
caf9323
Adjust FlowHash plugin
Zadamsa Oct 1, 2024
e2d7a6d
Adjust HTTP plugin
Zadamsa Oct 1, 2024
91c24a2
Adjust ICMP plugin
Zadamsa Oct 1, 2024
8281ce6
Adjust QUIC plugin
Zadamsa Oct 1, 2024
2c4b9c7
Adjust IDPContent plugin
Zadamsa Oct 1, 2024
35a4ab8
Adjust MPLS plugin
Zadamsa Oct 1, 2024
69d6db2
Adjust MQTT plugin
Zadamsa Oct 1, 2024
ee7fd38
Adjust NETBIOS plugin
Zadamsa Oct 1, 2024
9190333
Adjust NETTISA plugin
Zadamsa Oct 1, 2024
26c3edd
Adjust NTP plugin
Zadamsa Oct 1, 2024
8acefc5
Adjust OSQUERY plugin
Zadamsa Oct 1, 2024
8211869
Adjust OVPN plugin
Zadamsa Oct 1, 2024
181af80
Adjust PassiveDNS plugin
Zadamsa Oct 1, 2024
a85ed1d
Adjust PHISTS plugin
Zadamsa Oct 1, 2024
92a1e5b
Adjust PSTATS plugin
Zadamsa Oct 1, 2024
468aca8
Adjust RTSP plugin
Zadamsa Oct 1, 2024
7fdfe77
Adjust SIP plugin
Zadamsa Oct 1, 2024
f50ec47
Adjust SMTP plugin
Zadamsa Oct 1, 2024
35e2dec
Adjust SSADetector plugin
Zadamsa Oct 1, 2024
0767026
Adjust SSDP plugin
Zadamsa Oct 1, 2024
06ee8a6
Adjust Stats plugin
Zadamsa Oct 1, 2024
84b4334
Adjust TLS plugin
Zadamsa Oct 1, 2024
4083a7e
Adjust VLAN plugin
Zadamsa Oct 1, 2024
b62b05a
Adjust WG plugin
Zadamsa Oct 1, 2024
148ee87
ndp ctt integration - create definition of metadata
jaroslavpesek Nov 11, 2024
0f11ba8
ndp ctt integration - use ctt metadata for parsing
jaroslavpesek Nov 11, 2024
1a76726
ndp ctt integration - parsing metadata from ndp pkt
jaroslavpesek Nov 11, 2024
ffd22a2
ndp ctt integration - fix codestyle
jaroslavpesek Nov 11, 2024
a0a0b0b
Fix http return value
Zadamsa Nov 11, 2024
3d17864
ndp ctt table controller - init
jaroslavpesek Nov 12, 2024
9865e8a
ctt - add cache-ctt
jaroslavpesek Nov 13, 2024
4dffe03
ctt controller - add ctt state to flow
jaroslavpesek Nov 18, 2024
a296797
ndp ctt controller - ctt cond compilation
jaroslavpesek Nov 21, 2024
5dc6997
ctt - solving hazard during inconsistent state
jaroslavpesek Nov 28, 2024
ccabbd8
Refactor cache
Zadamsa Dec 21, 2024
cf91b1c
Add CTT support
Zadamsa Dec 22, 2024
15ddaf6
++ flow record
Zadamsa Jan 4, 2025
b146021
++ cache row span
Zadamsa Jan 4, 2025
9fc83af
++ cache
Zadamsa Jan 4, 2025
059b664
++ cache
Zadamsa Jan 4, 2025
dcfbb0c
++ cache
Zadamsa Jan 4, 2025
88a2af1
++ cache
Zadamsa Jan 4, 2025
8bf6fa9
++ cache
Zadamsa Jan 4, 2025
3825a6a
++ cache
Zadamsa Jan 5, 2025
8405837
++ fix plugin events
Zadamsa Jan 5, 2025
f1f2511
++ flow key
Zadamsa Jan 5, 2025
d55b500
++ cache
Zadamsa Jan 5, 2025
77eeac0
new ndp ctt refactor
Zadamsa Jan 5, 2025
157184e
ipfixprobe.cpp ctt refactor
Zadamsa Jan 5, 2025
3efc68e
++ cache
Zadamsa Jan 5, 2025
dd46483
cache opt parser refactor
Zadamsa Jan 5, 2025
4546a8f
input.hpp ctt refactor
Zadamsa Jan 5, 2025
1439f3c
++ cache row span
Zadamsa Jan 5, 2025
31dd2de
++ cache
Zadamsa Jan 5, 2025
8af09a3
++ flow record
Zadamsa Jan 5, 2025
088e9d7
base storage plugin ctt refactor
Zadamsa Jan 5, 2025
ef25de7
++ cache
Zadamsa Jan 5, 2025
fef454e
++ cache
Zadamsa Jan 5, 2025
8bf465f
++ makefile
Zadamsa Jan 5, 2025
9f1f14b
++ storage.hpp
Zadamsa Jan 5, 2025
3039829
todo remove debug cache
Zadamsa Jan 6, 2025
c01e6fa
++ cache
Zadamsa Jan 6, 2025
ec5c13b
++ cache
Zadamsa Jan 6, 2025
4ea5b17
++ cache
Zadamsa Jan 6, 2025
e002d94
++ cache
Zadamsa Jan 6, 2025
cddd010
++ cache
Zadamsa Jan 6, 2025
5b3c4e4
++ cache
Zadamsa Jan 6, 2025
ef29bf7
++ cache
Zadamsa Jan 6, 2025
c82bb2b
++ cache
Zadamsa Jan 6, 2025
e9dd268
++ cache
Zadamsa Jan 6, 2025
937246f
++ cache
Zadamsa Jan 6, 2025
b67d550
++ cache
Zadamsa Jan 6, 2025
44c0c8d
++ cache
Zadamsa Jan 6, 2025
8399918
++ cache
Zadamsa Jan 6, 2025
8283361
++ cache
Zadamsa Jan 6, 2025
26b19b6
++ cache
Zadamsa Jan 6, 2025
0ab097b
++ cache
Zadamsa Jan 6, 2025
68e0963
++ flow record
Zadamsa Jan 6, 2025
3c770e7
++ cachr
Zadamsa Jan 6, 2025
b128ac6
++ cache
Zadamsa Jan 6, 2025
d34f1a7
++ ctt controller
Zadamsa Jan 6, 2025
20f0d10
++ cachr
Zadamsa Jan 7, 2025
0c5f9ac
++ controller
Zadamsa Jan 7, 2025
fbf5a65
++ cache
Zadamsa Jan 7, 2025
67b7792
++ cache
Zadamsa Jan 10, 2025
9d01c18
++ cache
Zadamsa Jan 10, 2025
b225a68
++ cache
Zadamsa Jan 10, 2025
5ec7e94
++ cache
Zadamsa Jan 10, 2025
e2f25f6
++ cache row span
Zadamsa Jan 10, 2025
e5394e2
++ cache
Zadamsa Jan 10, 2025
6ba78c1
++ cache row span
Zadamsa Jan 17, 2025
f6b3e52
++ cache
Zadamsa Jan 17, 2025
2106c7b
++ ndp
Zadamsa Jan 17, 2025
a94d431
++ cache
Zadamsa Jan 17, 2025
0db99d9
++ ctt controller
Zadamsa Jan 18, 2025
f5472b5
++ ndp
Zadamsa Jan 20, 2025
72f473d
++ makefile
Zadamsa Jan 21, 2025
32a611d
++ cache
Zadamsa Jan 21, 2025
7d43644
++ flowkey
Zadamsa Jan 21, 2025
a0d5fe3
++ flowkey
Zadamsa Jan 21, 2025
6a96b7d
++ cache
Zadamsa Jan 21, 2025
979556f
++ cache
Zadamsa Jan 23, 2025
1d227c7
++ flowKey
Zadamsa Jan 23, 2025
8386e8b
++ flow key
Zadamsa Jan 23, 2025
b66cf62
++ ctt controller
Zadamsa Jan 24, 2025
42f17cf
++ cache
Zadamsa Jan 24, 2025
47c5e75
++ cache
Zadamsa Jan 24, 2025
e456e9d
++ cache
Zadamsa Jan 24, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,8 @@ tests/unit/utils
# vscode settings files
.vscode


# jekyll files
docs/_site/
docs/.sass-cache/
docs/.jekyll-metadata/
docs/.jekyll-cache/
11 changes: 11 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
2024-12-27 ipfixprobe-4.15.0
* dpdk: Add DPDK telemetry
* dpdk: add DPDK port telemetry
* dpdk: fix RSS configuration
* ipfix-elements: fix NTP_USEC_TO_FRAC macro
* docs: revision of web page
* README: update telemetry section

2024-11-14 ipfixprobe-4.14.0
* dpdk: set mempool size as rx queue size

2024-10-17 ipfixprobe-4.13.0
* usability: introduce docker/podman container to convert PCAP files to CSV
* IPFIX: fix order of TCP options flags
Expand Down
16 changes: 15 additions & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ ipfixprobe_storage_src=\
storage/fragmentationCache/fragmentationCache.cpp \
storage/cache.cpp \
storage/cache.hpp \
storage/cacheOptParser.hpp \
storage/cacheOptParser.cpp \
storage/flowRecord.hpp \
storage/flowRecord.cpp \
storage/cttController.hpp \
storage/cttController.cpp \
storage/cacheRowSpan.hpp \
storage/cacheRowSpan.cpp \
storage/xxhash.c \
storage/xxhash.h

Expand Down Expand Up @@ -180,6 +188,11 @@ ipfixprobe_input_src+=\
input/dpdk/dpdkMbuf.cpp \
input/dpdk/dpdkDevice.hpp \
input/dpdk/dpdkDevice.cpp \
input/dpdk/dpdkCompat.hpp \
input/dpdk/dpdkPortTelemetry.hpp \
input/dpdk/dpdkPortTelemetry.cpp \
input/dpdk/dpdkTelemetry.hpp \
input/dpdk/dpdkTelemetry.cpp \
input/dpdk.cpp \
input/dpdk.h \
input/dpdk-ring.cpp \
Expand All @@ -203,7 +216,8 @@ ipfixprobe_headers_src=\
include/ipfixprobe/ipfix-elements.hpp \
include/ipfixprobe/rtp.hpp \
include/ipfixprobe/telemetry-utils.hpp \
include/ipfixprobe/parser-stats.hpp
include/ipfixprobe/parser-stats.hpp \
include/ipfixprobe/cttmeta.hpp

ipfixprobe_src=\
$(ipfixprobe_input_src) \
Expand Down
20 changes: 20 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
2024-12-27 (Pavel Siska): dpdk: Add DPDK telemetry
2024-12-27 (Pavel Siska): dpdk: add DPDK port telemetry
2024-12-27 (Pavel Siska): dpdk: add compatible definition macro to dpdkCompact Add RTE_ETH_RSS_GENEVE macro
2024-12-27 (Pavel Siska): dpdk: fix RSS configuration
2024-12-27 (Pavel Siska): dpdk: Add dpdkCompact - compatibility definitions for DPDK versions
2024-12-16 (Pavel Siska): README - update build requirements
2024-12-16 (Pavel Siska): configure.ac - add checks for telemetry and appfs libraries - Added AC_CHECK_LIB for 'telemetry' and 'appfs' to verify library availability. - Ensured 'LIBS' includes '-lappFs -ltelemetry' for proper linking. - Updated RPM dependencies by appending 'telemetry' to RPM_REQUIRES and RPM_BUILDREQ.
2024-12-09 (Jan Sobol): ipfix-elements: fix NTP_USEC_TO_FRAC macro Use standard conversion to ntp timestamps as in https://tickelton.gitlab.io/articles/ntp-timestamps/.
2024-11-28 (Pavel Siska): Readme - update telemetry docs
2024-11-25 (Karel Hynek): docs: fix jekyll links
2024-11-25 (Karel Hynek): docs: fix jekyll base url and update docs description
2024-11-25 (Karel Hynek): docs: fix centering in the website footer
2024-11-20 (Tomas Cejka): docs: revision of web page
2024-11-15 (Karel Hynek): doc: FIX GitHub logo in footer
2024-11-15 (Karel Hynek): README: FIX ipfixprobe logo and link to documentation
2024-11-15 (Karel Hynek): Introduce doc using Jekyll & Update README (#232)

2024-11-12 (Jan Sobol): dpdkDevice: use mempool size as rx queue size instead of burst size
2024-11-12 (Jan Sobol): dpdk: reduce value of DEFAULT_MBUF_POOL_SIZE to use it also as rx queue size

2024-10-17 (Tomas Cejka): doc: include generated Doxyfile to create documentation
2024-10-17 (Tomas Cejka): doc: add doxygen comment for parse_packet()
2024-10-16 (Jan Sobol): dpdk-ring - fix checking if any packet has actually been parsed
Expand Down
800 changes: 160 additions & 640 deletions README.md

Large diffs are not rendered by default.

42 changes: 41 additions & 1 deletion configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.69])
AC_INIT([ipfixprobe], [4.13.0], [nemea@cesnet.cz])
AC_INIT([ipfixprobe], [4.15.0], [nemea@cesnet.cz])

AC_CONFIG_SRCDIR([main.cpp])
AC_CONFIG_HEADERS([config.h])
Expand Down Expand Up @@ -226,6 +226,32 @@ if [[ -z "$WITH_NDP_TRUE" ]]; then
RPM_BUILDREQ+=" netcope-common-devel"
fi

AC_ARG_WITH([ctt],
AC_HELP_STRING([--with-ctt],[Compile ipfixprobe with ctt plugin for using Connection Tracking Table]),
[
if test "$withval" = "yes"; then
withctt="yes"
else
withctt="no"
fi
], [withctt="no"]
)

if test x${withctt} = xyes; then
AC_LANG_PUSH([C++])
CXXFLAGS="$CXXFLAGS -std=c++17"
AC_CHECK_HEADERS([ctt.hpp], [libctt=yes], AC_MSG_ERROR([ctt.hpp not found. Try installing libctt-devel]))
AC_LANG_POP([C++])
fi

AM_CONDITIONAL(WITH_CTT, test x${libctt} = xyes && test x${withctt} = xyes)
if [[ -z "$WITH_CTT_TRUE" ]]; then
AC_DEFINE([WITH_CTT], [1], [Define to 1 if the ctt is available])
LIBS="-lctt $LIBS"
RPM_REQUIRES+=" libctt"
RPM_BUILDREQ+=" libctt-devel"
fi

AC_ARG_WITH([pcap],
AC_HELP_STRING([--with-pcap],[Compile ipfixprobe with pcap plugin for capturing using libpcap library]),
[
Expand Down Expand Up @@ -382,6 +408,20 @@ AC_ARG_WITH([stem],
[withstem="no"]
)

# Check if the telemetry library is available
AC_CHECK_LIB([telemetry], [main],
[AC_MSG_RESULT([Found telemetry library.])],
[AC_MSG_ERROR([The telemetry library is required but was not found. Try to install telemetry.])])

# Check if the appfs library is available
AC_CHECK_LIB([appFs], [main],
[AC_MSG_RESULT([Found appfs library.])],
[AC_MSG_ERROR([The appfs library is required but was not found. Try to install telemetry])])

LIBS="-lappFs -ltelemetry $LIBS"
RPM_REQUIRES+=" telemetry"
RPM_BUILDREQ+=" telemetry"

AM_CONDITIONAL(WITH_STEM, test x${withstem} = xyes)
if [[ -z "$WITH_STEM_TRUE" ]]; then
AC_DEFINE([WITH_STEM], [1], [Define to 1 to use flexprobe testing interface])
Expand Down
6 changes: 6 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Not Found
description: This does not exist
permalink: /404.html
sitemap: false
---
11 changes: 11 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
source 'https://rubygems.org'
gem "webrick"
gem 'jekyll', '~> 4.2.0'

group :jekyll_plugins do
gem 'jekyll-archives', '~> 2.2.1'
gem 'jekyll-feed', '~> 0.15.1'
gem 'jekyll-paginate', '~> 1.1.0'
gem 'jekyll-seo-tag', '~> 2.7.1'
gem 'jekyll-sitemap', '~> 1.4.0'
end
83 changes: 83 additions & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
colorator (1.1.0)
concurrent-ruby (1.1.9)
em-websocket (0.5.2)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
ffi (1.15.1)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
i18n (1.8.10)
concurrent-ruby (~> 1.0)
jekyll (4.2.0)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (~> 2.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.4.0)
pathutil (~> 0.9)
rouge (~> 3.0)
safe_yaml (~> 1.0)
terminal-table (~> 2.0)
jekyll-archives (2.2.1)
jekyll (>= 3.6, < 5.0)
jekyll-feed (0.15.1)
jekyll (>= 3.7, < 5.0)
jekyll-paginate (1.1.0)
jekyll-sass-converter (2.1.0)
sassc (> 2.0.1, < 3.0)
jekyll-seo-tag (2.7.1)
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.3.1)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.5.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.6)
rb-fsevent (0.11.0)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.26.0)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
terminal-table (2.0.0)
unicode-display_width (~> 1.1, >= 1.1.1)
unicode-display_width (1.7.0)
webrick (1.8.1)

PLATFORMS
ruby

DEPENDENCIES
jekyll (~> 4.2.0)
jekyll-archives (~> 2.2.1)
jekyll-feed (~> 0.15.1)
jekyll-paginate (~> 1.1.0)
jekyll-seo-tag (~> 2.7.1)
jekyll-sitemap (~> 1.4.0)
webrick

BUNDLED WITH
1.17.3
21 changes: 21 additions & 0 deletions docs/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2016-2020 CloudCannon

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
71 changes: 71 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# ipfixprobe website Hydra

Based on Hydra opensource template [live demo](https://proud-alligator.cloudvent.net/)

## Features

* Contact form
* Pre-built pages
* Pre-styled components
* Blog with pagination
* Post category pages
* Disqus comments for posts
* Staff and author system
* Configurable footer
* Optimised for editing in [CloudCannon](http://cloudcannon.com/)
* RSS/Atom feed
* SEO tags
* Google Analytics

## Setup

1. Add your site and author details in `_config.yml`.
2. Add your Google Analytics and Disqus keys to `_config.yml`.
3. Get a workflow going to see your site's output (with [CloudCannon](https://app.cloudcannon.com/) or Jekyll locally).

## Develop

Hydra was built with [Jekyll](http://jekyllrb.com/) version 3.3.1, but should support newer versions as well.

Install the dependencies with [Bundler](http://bundler.io/):

~~~bash
$ bundle install
~~~

Run `jekyll` commands through Bundler to ensure you're using the right versions:

~~~bash
$ bundle exec jekyll serve
~~~

## Editing

Hydra is already optimised for adding, updating and removing pages, staff, advice, company details and footer elements in CloudCannon.

### Posts

* Add, update or remove a post in the *Posts* collection.
* The **Staff Author** field links to members in the **Staff** collection.
* Documentation pages are organised in the navigation by category, with URLs based on the path inside the `_docs` folder.
* Change the defaults when new posts are created in `_posts/_defaults.md`.

### Contact Form

* Preconfigured to work with CloudCannon, but easily changed to another provider (e.g. [FormSpree](https://formspree.io/)).
* Sends email to the address listed in company details.

### Staff

* Reused around the site to save multiple editing locations.
* Add `excluded_in_search: true` to any documentation page's front matter to exclude that page in the search results.

### Navigation

* Exposed as a data file to give clients better access.
* Set in the *Data* / *Navigation* section.

### Footer

* Exposed as a data file to give clients better access.
* Set in the *Data* / *Footer* section.
Loading