README.md: mention that flags may be read from env vars if -envflag.enable command-line flag is set

This commit is contained in:
Aliaksandr Valialkin 2020-02-10 16:19:57 +02:00
parent 025297f15d
commit 9e6e2319b9

View file

@ -131,12 +131,12 @@ The following command-line flags are used the most:
* `-storageDataPath` - path to data directory. VictoriaMetrics stores all the data in this directory. Default path is `victoria-metrics-data` in current working directory.
* `-retentionPeriod` - retention period in months for the data. Older data is automatically deleted. Default period is 1 month.
* `-httpListenAddr` - TCP address to listen to for http requests. By default, it listens port `8428` on all the network interfaces.
* `-graphiteListenAddr` - TCP and UDP address to listen to for Graphite data. By default, it is disabled.
* `-opentsdbListenAddr` - TCP and UDP address to listen to for OpenTSDB data over telnet protocol. By default, it is disabled.
* `-opentsdbHTTPListenAddr` - TCP address to listen to for HTTP OpenTSDB data over `/api/put`. By default, it is disabled.
Pass `-help` to see all the available flags with description and default values.
Default flag values may be read from environment variables if `-envflag.enable` command-line flag is set.
See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/311) for more details.
It is recommended setting up [monitoring](#monitoring) for VictoriaMetrics.