johanels/akvorado
1
0
Fork 0
mirror of https://github.com/akvorado/akvorado.git synced 2025-12-12 06:24:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

doc: update a bit the intro

Browse Source
This commit is contained in:
Vincent Bernat
2022-06-28 16:17:09 +02:00
parent 8be1bca4fd
commit dcb77c0507
2 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,9 +1,10 @@
# Akvorado: flow collector, hydrater and exporter. # Akvorado: flow collector, hydrater and visualizer.
This program receives flows (currently Netflow/IPFIX), hydrates them with This program receives flows (currently Netflow/IPFIX), hydrates them
interface names (using SNMP), geo information (using MaxMind), and with interface names (using SNMP), geo information (using MaxMind),
exports them to Kafka. and exports them to Kafka, then ClickHouse. It also exposes a web
interface to browse the result.
## Documentation *Akvorado* is developed by [Free](https://www.free.fr), a French ISP,
and is licensed under the [AGPLv3 license](LICENSE.txt). The
The documentation is in the `docs/` directory. [documentation](/docs/00-intro.md) is in the `docs/` directory.

7
console/data/docs/00-intro.md
View File

@@ -1,8 +1,9 @@
# Introduction # Introduction
*Akvorado*[^name] is a flow collector, hydrater and exporter. It *Akvorado*[^name] receives flows (currently Netflow/IPFIX), hydrates
receives flows, adds some data like interface names and countries, and them with interface names (using SNMP), geo information (using
exports them to Kafka. MaxMind), and exports them to Kafka, then ClickHouse. It also exposes
a web interface to browse the result.
[^name]: [Akvorado][] means "water wheel" in Esperanto. [^name]: [Akvorado][] means "water wheel" in Esperanto.