diff --git a/README.md b/README.md index d286a172..91d46625 100644 --- a/README.md +++ b/README.md @@ -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 -interface names (using SNMP), geo information (using MaxMind), and -exports them to Kafka. +This program receives flows (currently Netflow/IPFIX), hydrates them +with interface names (using SNMP), geo information (using MaxMind), +and exports them to Kafka, then ClickHouse. It also exposes a web +interface to browse the result. -## Documentation - -The documentation is in the `docs/` directory. +*Akvorado* is developed by [Free](https://www.free.fr), a French ISP, +and is licensed under the [AGPLv3 license](LICENSE.txt). The +[documentation](/docs/00-intro.md) is in the `docs/` directory. diff --git a/console/data/docs/00-intro.md b/console/data/docs/00-intro.md index acebabed..b9f93cb8 100644 --- a/console/data/docs/00-intro.md +++ b/console/data/docs/00-intro.md @@ -1,8 +1,9 @@ # Introduction -*Akvorado*[^name] is a flow collector, hydrater and exporter. It -receives flows, adds some data like interface names and countries, and -exports them to Kafka. +*Akvorado*[^name] receives flows (currently Netflow/IPFIX), hydrates +them with interface names (using SNMP), geo information (using +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.