docs: update help text
Updates the main help text and adds config precedence order to server help text.pull/24376/head
parent
71daaffce6
commit
e88114425d
|
@ -30,7 +30,13 @@ lazy_static! {
|
||||||
long_about = "Run the IOx server.\n\nThe configuration options below can be \
|
long_about = "Run the IOx server.\n\nThe configuration options below can be \
|
||||||
set either with the command line flags or with the specified environment \
|
set either with the command line flags or with the specified environment \
|
||||||
variable. If there is a file named '.env' in the current working directory, \
|
variable. If there is a file named '.env' in the current working directory, \
|
||||||
it is sourced before loading the configuration."
|
it is sourced before loading the configuration.
|
||||||
|
|
||||||
|
Configuration is loaded from the following sources (highest precedence first):
|
||||||
|
- command line arguments
|
||||||
|
- user set environment variables
|
||||||
|
- .env file contents
|
||||||
|
- pre-configured default values"
|
||||||
)]
|
)]
|
||||||
pub struct Config {
|
pub struct Config {
|
||||||
/// This controls the IOx server logging level, as described in
|
/// This controls the IOx server logging level, as described in
|
||||||
|
|
|
@ -41,8 +41,8 @@ Examples:
|
||||||
# Run the InfluxDB IOx server:
|
# Run the InfluxDB IOx server:
|
||||||
influxdb_iox
|
influxdb_iox
|
||||||
|
|
||||||
# Display all current config settings
|
# Display all server settings
|
||||||
influxdb_iox config show
|
influxdb_iox server --help
|
||||||
|
|
||||||
# Run the InfluxDB IOx server with extra verbose logging
|
# Run the InfluxDB IOx server with extra verbose logging
|
||||||
influxdb_iox -v
|
influxdb_iox -v
|
||||||
|
|
Loading…
Reference in New Issue