From 6e6d62284c53871e915842b945f86dd454274145 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Wed, 18 Nov 2020 19:44:40 +0200 Subject: [PATCH] docs: make `snap install victoriametrics` more prominent in docs --- README.md | 6 ++++-- docs/Quick-Start.md | 6 ++++-- docs/Single-server-VictoriaMetrics.md | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 227a71455..529638b7e 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,10 @@ VictoriaMetrics is fast, cost-effective and scalable monitoring solution and time series database. It is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), -[docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and -in [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). Just download VictoriaMetrics and see [how to start it](#how-to-start-victoriametrics). +[docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap package](https://snapcraft.io/victoriametrics) +and in [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). Just download VictoriaMetrics and see [how to start it](#how-to-start-victoriametrics). +If you use Ubuntu, then just run `snap install victoriametrics` in order to install and run it. +Then read [Prometheus setup](#prometheus-setup) and [Grafana setup](#grafana-setup) docs. Cluster version is available [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/cluster). diff --git a/docs/Quick-Start.md b/docs/Quick-Start.md index 05d52ebea..77eb0236e 100644 --- a/docs/Quick-Start.md +++ b/docs/Quick-Start.md @@ -1,10 +1,12 @@ # Quick Start -1. Download the latest VictoriaMetrics release from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), +1. If you run Ubuntu, then just run `snap install victoriametrics` command in order to install and start VictoriaMetrics, then read [these docs](https://snapcraft.io/victoriametrics). + Otherwise download the latest VictoriaMetrics release from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), from [Docker hub](https://hub.docker.com/r/victoriametrics/victoria-metrics/) or [build it from sources](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki/Single-server-VictoriaMetrics#how-to-build-from-sources). -2. Run the binary or Docker image with the desired command-line flags. Pass `-help` in order to see description for all the available flags +2. This step isn't needed if you run VictoriaMetrics via `snap install victoriametrics` as described above. + Otherwise run the binary or Docker image with the desired command-line flags. Pass `-help` in order to see description for all the available flags and their default values. Default flag values should fit the majoirty of cases. The minimum required flags to configure are: * `-storageDataPath` - path to directory where VictoriaMetrics stores all the data. diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 227a71455..529638b7e 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -13,8 +13,10 @@ VictoriaMetrics is fast, cost-effective and scalable monitoring solution and time series database. It is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), -[docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and -in [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). Just download VictoriaMetrics and see [how to start it](#how-to-start-victoriametrics). +[docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap package](https://snapcraft.io/victoriametrics) +and in [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). Just download VictoriaMetrics and see [how to start it](#how-to-start-victoriametrics). +If you use Ubuntu, then just run `snap install victoriametrics` in order to install and run it. +Then read [Prometheus setup](#prometheus-setup) and [Grafana setup](#grafana-setup) docs. Cluster version is available [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/cluster).