diff --git a/cmd/root.go b/cmd/root.go index 579b76ac..328e53da 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -18,7 +18,7 @@ var debug bool // RootCmd is the root for all commands var RootCmd = &cobra.Command{ Use: "akvorado", - Short: "Export flows to Kafka", + Short: "Flow collector, hydrater and visualizer", PersistentPreRun: func(cmd *cobra.Command, args []string) { if isatty.IsTerminal(os.Stdout.Fd()) { log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr}) diff --git a/console/data/docs/01-install.md b/console/data/docs/01-install.md index c756db21..e6f29056 100644 --- a/console/data/docs/01-install.md +++ b/console/data/docs/01-install.md @@ -6,15 +6,38 @@ single binary or Docker image. It also requires an installation of [ClickHouse](https://clickhouse.com/docs/en/getting-started/install/). They have to be installed separately. +## Docker image + +You can get *Akvorado* as a +[Docker](https://docs.docker.com/get-docker) image. + +```console +# docker pull ghcr.io/vincentbernat/akvorado:latest +# docker run --rm ghcr.io/vincentbernat/akvorado:latest help +``` + +Check the `docker-compose.yml` file for an example on how to deploy +*Akvorado* using containers. + +## Pre-built binary + +The second option is to get a pre-built binary from the [release page +on GitHub](https://github.com/vincentbernat/akvorado/releases). +Currently, only a pre-built binary for Linux x86-64 is provided. + ## Compilation from source You need a proper installation of [Go](https://go.dev/doc/install) -(1.18+), [NodeJS](https://nodejs.org/en/download/), and -[protoc](https://grpc.io/docs/protoc-installation/). For example, on -Debian: +(1.18+), [NodeJS](https://nodejs.org/en/download/) (12+) with NPM +(7+), and [protoc](https://grpc.io/docs/protoc-installation/). For +example, on Debian: ```console # apt install golang-1.18 nodejs npm protobuf-compiler +# node --version +v16.15.1 +# npm --version +8.14.0 ``` Then, type: @@ -61,15 +84,6 @@ The following `make` targets are available: - `make lint` to lint source code - `make fmt` to format source code -## Docker image - -It is also possible to get Akvorado as a -[Docker](https://docs.docker.com/get-docker) image: - -```console -# docker pull ghcr.io/vincentbernat/akvorado:latest -``` - ## Upgrade Be sure to read the [changelog](99-changelog.md) before attempting an