34 KiB
title | description | menu | weight | products | related | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
InfluxDB configuration options | Customize your InfluxDB configuration by using [`influxd`](/v2.0/reference/cli/influxd/) configuration flags, setting environment variables, or defining configuration options in a configuration file. |
|
3 |
|
|
Customize your InfluxDB configuration by using influxd
configuration flags, setting environment variables, or defining configuration
options in a configuration file.
Configuration precedence
InfluxDB honors configuration settings using the following precedence:
influxd
flags- Environment variables
- Configuration file settings
InfluxDB configuration file
When influxd
starts, it checks for a file named config.*
in the current working directory.
The file extension depends on the syntax of the configuration file.
InfluxDB configuration files support the following syntaxes:
- YAML (
.yaml
,.yml
) - TOML (
.toml
) - JSON (
.json
)
To customize the directory path of the configuration file, set the INFLUXD_CONFIG_PATH
environment variable to your custom path.
export INFLUXD_CONFIG_PATH=/path/to/custom/config/directory
On startup, influxd
will check for a config.*
in the INFLUXD_CONFIG_PATH
directory.
Example configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
query-concurrency: 20
query-queue-size: 15
secret-store: vault
session-length: 120
tls-cert: /path/to/influxdb.crt
tls-key: /path/to/influxdb.key
{{% /code-tab-content %}} {{% code-tab-content %}}
query-concurrency = 20
query-queue-size = 15
secret-store = "vault"
session-length = 120
tls-cert = "/path/to/influxdb.crt"
tls-key = "/path/to/influxdb.key"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"query-concurrency": 20,
"query-queue-size": 15,
"secret-store": "vault",
"session-length": 120,
"tls-cert": "/path/to/influxdb.crt",
"tls-key": "/path/to/influxdb.key"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
{{% note %}} Only non-default settings need to be defined in the configuration file. {{% /note %}}
Configuration options
To configure InfluxDB, use the following configuration options when starting the
influxd
service:
- assets-path
- bolt-path
- e2e-testing
- engine-path
- http-bind-address
- log-level
- new-meta-store
- new-meta-store-read-only
- no-tasks
- query-concurrency
- query-initial-memory-bytes
- query-max-memory-bytes
- query-memory-bytes
- query-queue-size
- reporting-disabled
- secret-store
- session-length
- session-renew-disabled
- store
- tls-cert
- tls-key
- tracing-type
- vault-addr
- vault-cacert
- vault-capath
- vault-client-cert
- vault-client-key
- vault-max-retries
- vault-client-timeout
- vault-skip-verify
- vault-tls-server-name
- vault-token
assets-path
Override the default InfluxDB user interface (UI) assets by serving assets from the specified directory. Typically, InfluxData internal use only.
influxd flag | Environment variable | Configuration key |
---|---|---|
--assets-path |
INFLUXD_ASSETS_PATH |
assets-path |
influxd flag
influxd --assets-path=/path/to/custom/assets-dir
Environment variable
export INFLUXD_ASSETS_PATH=/path/to/custom/assets-dir
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
assets-path: /path/to/custom/assets-dir
{{% /code-tab-content %}} {{% code-tab-content %}}
assets-path = "/path/to/custom/assets-dir"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"assets-path": "/path/to/custom/assets-dir"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
bolt-path
Define the path to the BoltDB database. BoltDB is a key value store written in Go. InfluxDB uses BoltDB to store data including organization and user information, UI data, REST resources, and other key value data.
Default: ~/.influxdbv2/influxd.bolt
influxd flag | Environment variable | Configuration key |
---|---|---|
--bolt-path |
INFLUXD_BOLT_PATH |
bolt-path |
influxd flag
influxd --bolt-path=~/.influxdbv2/influxd.bolt
Environment variable
export INFLUXD_BOLT_PATH=~/.influxdbv2/influxd.bolt
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
bolt-path: /users/user/.influxdbv2/influxd.bolt
{{% /code-tab-content %}} {{% code-tab-content %}}
bolt-path = "/users/user/.influxdbv2/influxd.bolt"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"bolt-path": "/users/user/.influxdbv2/influxd.bolt"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
e2e-testing
Add a /debug/flush
endpoint to the InfluxDB HTTP API to clear stores.
InfluxData uses this endpoint in end-to-end testing.
influxd flag | Environment variable | Configuration key |
---|---|---|
--e2e-testing |
INFLUXD_E2E_TESTING |
e2e-testing |
influxd flag
influxd --e2e-testing
Environment variable
export INFLUXD_E2E_TESTING=true
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
e2e-testing: true
{{% /code-tab-content %}} {{% code-tab-content %}}
e2e-testing = true
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"e2e-testing": true
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
engine-path
Define the path to persistent storage engine files where InfluxDB stores all Time-Structure Merge Tree (TSM) data on disk.
Default: ~/.influxdbv2/engine
influxd flag | Environment variable | Configuration key |
---|---|---|
--engine-path |
INFLUXD_ENGINE_PATH |
engine-path |
influxd flag
influxd --engine-path=~/.influxdbv2/engine
Environment variable
export INFLUXD_ENGINE_PATH=~/.influxdbv2/engine
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
engine-path: /users/user/.influxdbv2/engine
{{% /code-tab-content %}} {{% code-tab-content %}}
engine-path = "/users/user/.influxdbv2/engine"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"engine-path": "/users/user/.influxdbv2/engine"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
http-bind-address
Define the bind address for the InfluxDB HTTP API. Customize the URL and port for the InfluxDB API and UI.
Default: :9999
influxd flag | Environment variable | Configuration key |
---|---|---|
--http-bind-address |
INFLUXD_HTTP_BIND_ADDRESS |
http-bind-address |
influxd flag
influxd --http-bind-address=:9999
Environment variable
export INFLUXD_HTTP_BIND_ADDRESS=:9999
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
http-bind-address: ":9999"
{{% /code-tab-content %}} {{% code-tab-content %}}
http-bind-address = ":9999"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"http-bind-address": ":9999"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
log-level
Define the log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
Options: debug
, info
, error
Default: info
influxd flag | Environment variable | Configuration key |
---|---|---|
--log-level |
INFLUXD_LOG_LEVEL |
log-level |
influxd flag
influxd --log-level=info
Environment variable
export INFLUXD_LOG_LEVEL=info
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
log-level: info
{{% /code-tab-content %}} {{% code-tab-content %}}
log-level = "info"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"log-level": "info"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
new-meta-store
Enable the new meta store.
Default: false
influxd flag | Environment variable | Configuration key |
---|---|---|
--new-meta-store |
INFLUXD_NEW_META_STORE |
new-meta-store |
influxd flag
influxd --new-meta-store
Environment variable
export INFLUXD_NEW_META_STORE=true
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
new-meta-store: true
{{% /code-tab-content %}} {{% code-tab-content %}}
new-meta-store = true
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"new-meta-store": true
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
new-meta-store-read-only
Toggle read-only mode for the new meta store.
If true
, reads are duplicated between old and new meta stores
(if new meta store is enabled).
Default: true
influxd flag | Environment variable | Configuration key |
---|---|---|
--new-meta-store-read-only |
INFLUXD_NEW_META_STORE_READ_ONLY |
new-meta-store-read-only |
influxd flag
influxd --new-meta-store-read-only
Environment variable
export INFLUXD_NEW_META_STORE_READ_ONLY=true
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
new-meta-store-read-only: true
{{% /code-tab-content %}} {{% code-tab-content %}}
new-meta-store-read-only = true
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"new-meta-store-read-only": true
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
no-tasks
Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.
Default: false
influxd flag | Environment variable | Configuration key |
---|---|---|
--no-tasks |
INFLUXD_NO_TASKS |
no-tasks |
influxd flag
influxd --no-tasks
Environment variable
export INFLUXD_NO_TASKS=true
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
no-tasks: true
{{% /code-tab-content %}} {{% code-tab-content %}}
no-tasks = true
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"no-tasks": true
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
query-concurrency
Number of queries allowed to execute concurrently.
Default: 10
influxd flag | Environment variable | Configuration key |
---|---|---|
--query-concurrency |
INFLUXD_QUERY_CONCURRENCY |
query-concurrency |
influxd flag
influxd --query-concurrency=10
Environment variable
export INFLUXD_QUERY_CONCURRENCY=10
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
query-concurrency: 10
{{% /code-tab-content %}} {{% code-tab-content %}}
query-concurrency = 10
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"query-concurrency": 10
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
query-initial-memory-bytes
Initial bytes of memory allocated for a query.
Default: equal to query-memory-bytes
influxd flag | Environment variable | Configuration key |
---|---|---|
--query-initial-memory-bytes |
INFLUXD_QUERY_INITIAL_MEMORY_BYTES |
query-initial-memory-bytes |
influxd flag
influxd --query-initial-memory-bytes=10485760
Environment variable
export INFLUXD_QUERY_INITIAL_MEMORY_BYTES=10485760
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
query-initial-memory-bytes: 10485760
{{% /code-tab-content %}} {{% code-tab-content %}}
query-initial-memory-bytes = 10485760
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"query-initial-memory-bytes": 10485760
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
query-max-memory-bytes
Maximum total bytes of memory allowed for queries.
Default: equal to query-concurrency × query-memory-bytes
influxd flag | Environment variable | Configuration key |
---|---|---|
--query-max-memory-bytes |
INFLUXD_QUERY_MAX_MEMORY_BYTES |
query-max-memory-bytes |
influxd flag
influxd --query-max-memory-bytes=104857600
Environment variable
export INFLUXD_QUERY_MAX_MEMORY_BYTES=104857600
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
query-max-memory-bytes: 104857600
{{% /code-tab-content %}} {{% code-tab-content %}}
query-max-memory-bytes = 104857600
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"query-max-memory-bytes": 104857600
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
query-memory-bytes
Maximum bytes of memory allowed for a single query.
Default: unlimited
{{% note %}} Must be greater than or equal to query-initial-memory-bytes. {{% /note %}}
influxd flag | Environment variable | Configuration key |
---|---|---|
--query-memory-bytes |
INFLUXD_QUERY_MEMORY_BYTES |
query-memory-bytes |
influxd flag
influxd --query-memory-bytes=10485760
Environment variable
export INFLUXD_QUERY_MEMORY_BYTES=10485760
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
query-memory-bytes: 10485760
{{% /code-tab-content %}} {{% code-tab-content %}}
query-memory-bytes = 10485760
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"query-memory-bytes": 10485760
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
query-queue-size
Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected.
Default: 10
influxd flag | Environment variable | Configuration key |
---|---|---|
--query-queue-size |
INFLUXD_QUERY_QUEUE_SIZE |
query-queue-size |
influxd flag
influxd --query-queue-size=10
Environment variable
export INFLUXD_QUERY_QUEUE_SIZE=10
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
query-queue-size: 10
{{% /code-tab-content %}} {{% code-tab-content %}}
query-queue-size = 10
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"query-queue-size": 10
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
reporting-disabled
Disables sending telemetry data to InfluxData. The InfluxData telemetry page provides information about what data is collected and how InfluxData uses it.
Default: false
influxd flag | Environment variable | Configuration key |
---|---|---|
--reporting-disabled |
INFLUXD_REPORTING_DISABLED |
reporting-disabled |
influxd flag
influxd --reporting-disabled
Environment variable
export INFLUXD_REPORTING_DISABLED=true
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
reporting-disabled: true
{{% /code-tab-content %}} {{% code-tab-content %}}
reporting-disabled = true
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"reporting-disabled": true
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
secret-store
Specifies the data store for secrets such as passwords and tokens. Store secrets in either the InfluxDB internal BoltDB or in Vault.
Options: bolt
, vault
Default: bolt
influxd flag | Environment variable | Configuration key |
---|---|---|
--secret-store |
INFLUXD_SECRET_STORE |
secret-store |
influxd flag
influxd --secret-store=bolt
Environment variable
export INFLUXD_SECRET_STORE=bolt
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
secret-store: bolt
{{% /code-tab-content %}} {{% code-tab-content %}}
secret-store = "bolt"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"secret-store": "bolt"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
session-length
Specifies the Time to Live (TTL) in minutes for newly created user sessions.
Default: 60
influxd flag | Environment variable | Configuration key |
---|---|---|
--session-length |
INFLUXD_SESSION_LENGTH |
session-length |
influxd flag
influxd --session-length=60
Environment variable
export INFLUXD_SESSION_LENGTH=60
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
session-length: 60
{{% /code-tab-content %}} {{% code-tab-content %}}
session-length = 60
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"session-length": 60
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
session-renew-disabled
Disables automatically extending a user's session TTL on each request. By default, every request sets the session's expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.
Default: false
influxd flag | Environment variable | Configuration key |
---|---|---|
--session-renew-disabled |
INFLUXD_SESSION_RENEW_DISABLED |
session-renew-disabled |
influxd flag
influxd --session-renew-disabled
Environment variable
export INFLUXD_SESSION_RENEW_DISABLED=true
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
session-renew-disabled: true
{{% /code-tab-content %}} {{% code-tab-content %}}
session-renew-disabled = true
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"session-renew-disabled": true
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
store
Specifies the data store for REST resources.
Options: bolt
, memory
Default: bolt
{{% note %}}
memory
is meant for transient environments, such as testing environments, where
data persistence does not matter.
InfluxData does not recommend using memory
in production.
{{% /note %}}
influxd flag | Environment variable | Configuration key |
---|---|---|
--store |
INFLUXD_STORE |
store |
influxd flag
influxd --store=bolt
Environment variable
export INFLUXD_STORE=bolt
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
store: bolt
{{% /code-tab-content %}} {{% code-tab-content %}}
store = "bolt"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"store": "bolt"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
tls-cert
Path to TLS certificate file.
Requires the tls-key
to be set.
For more information, see Enable TLS encryption.
influxd flag | Environment variable | Configuration key |
---|---|---|
--tls-cert |
INFLUXD_TLS_CERT |
tls-cert |
influxd flag
influxd --tls-cert=/path/to/influxdb.crt
Environment variable
export INFLUXD_TLS_CERT=/path/to/influxdb.crt
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
tls-cert: /path/to/influxdb.crt
{{% /code-tab-content %}} {{% code-tab-content %}}
tls-cert = "/path/to/influxdb.crt"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"tls-cert": "/path/to/influxdb.crt"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
tls-key
Path to TLS key file.
Requires the tls-cert
to be set.
For more information, see Enable TLS encryption.
influxd flag | Environment variable | Configuration key |
---|---|---|
--tls-key |
INFLUXD_TLS_KEY |
tls-key |
influxd flag
influxd --tls-key=/path/to/influxdb.key
Environment variable
export INFLUXD_TLS_KEY=/path/to/influxdb.key
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
tls-key: /path/to/influxdb.key
{{% /code-tab-content %}} {{% code-tab-content %}}
tls-key = "/path/to/influxdb.key"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"tls-key": "/path/to/influxdb.key"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
tracing-type
Enables tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
Options: log
, jaeger
influxd flag | Environment variable | Configuration key |
---|---|---|
--tracing-type |
INFLUXD_TRACING_TYPE |
tracing-type |
influxd flag
influxd --tracing-type=log
Environment variable
export INFLUXD_TRACING_TYPE=log
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
tracing-type: log
{{% /code-tab-content %}} {{% code-tab-content %}}
tracing-type = "log"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"tracing-type": "log"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
vault-addr
Specifies the address of the Vault server expressed as a URL and port.
For example: https://127.0.0.1:8200/
.
influxd flag | Environment variable | Configuration key |
---|---|---|
--vault-addr |
VAULT_ADDR |
vault-addr |
influxd flag
influxd --vault-addr=https://127.0.0.1:8200/
Environment variable
export VAULT_ADDR=https://127.0.0.1:8200/
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
vault-addr: https://127.0.0.1:8200/
{{% /code-tab-content %}} {{% code-tab-content %}}
vault-addr = "https://127.0.0.1:8200/"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"vault-addr": "https://127.0.0.1:8200/"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
vault-cacert
Specifies the path to a PEM-encoded CA certificate file on the local disk.
This file is used to verify the Vault server's SSL certificate.
This setting takes precedence over the --vault-capath
setting.
influxd flag | Environment variable | Configuration key |
---|---|---|
--vault-cacert |
VAULT_CACERT |
vault-cacert |
influxd flag
influxd --vault-cacert=/path/to/ca.pem
Environment variable
export VAULT_CACERT=/path/to/ca.pem
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
vault-cacert: /path/to/ca.pem
{{% /code-tab-content %}} {{% code-tab-content %}}
vault-cacert = "/path/to/ca.pem"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"vault-cacert": "/path/to/ca.pem"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
vault-capath
Specifies the path to a directory of PEM-encoded CA certificate files on the local disk. These certificates are used to verify the Vault server's SSL certificate.
influxd flag | Environment variable | Configuration key |
---|---|---|
--vault-capath |
VAULT_CAPATH |
vault-capath |
influxd flag
influxd --vault-capath=/path/to/certs/
Environment variable
export VAULT_CAPATH=/path/to/certs/
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
vault-capath: /path/to/certs/
{{% /code-tab-content %}} {{% code-tab-content %}}
vault-capath = "/path/to/certs/"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"vault-capath": "/path/to/certs/"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
vault-client-cert
Specifies the path to a PEM-encoded client certificate on the local disk. This file is used for TLS communication with the Vault server.
influxd flag | Environment variable | Configuration key |
---|---|---|
--vault-client-cert |
VAULT_CLIENT_CERT |
vault-client-cert |
influxd flag
influxd --vault-client-cert=/path/to/client_cert.pem
Environment variable
export VAULT_CLIENT_CERT=/path/to/client_cert.pem
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
vault-client-cert: /path/to/client_cert.pem
{{% /code-tab-content %}} {{% code-tab-content %}}
vault-client-cert = "/path/to/client_cert.pem"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"vault-client-cert": "/path/to/client_cert.pem"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
vault-client-key
Specifies the path to an unencrypted, PEM-encoded private key on disk which corresponds to the matching client certificate.
influxd flag | Environment variable | Configuration key |
---|---|---|
--vault-client-key |
VAULT_CLIENT_KEY |
vault-client-key |
influxd flag
influxd --vault-client-key=/path/to/private_key.pem
Environment variable
export VAULT_CLIENT_KEY=/path/to/private_key.pem
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
vault-client-key: /path/to/private_key.pem
{{% /code-tab-content %}} {{% code-tab-content %}}
vault-client-key = "/path/to/private_key.pem"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"vault-client-key": "/path/to/private_key.pem"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
vault-max-retries
Specifies the maximum number of retries when encountering a 5xx error code. The default is 2 (for three attempts in total). Set this to 0 or less to disable retrying.
Default: 2
influxd flag | Environment variable | Configuration key |
---|---|---|
--vault-max-retries |
VAULT_MAX_RETRIES |
vault-max-retries |
influxd flag
influxd --vault-max-retries=2
Environment variable
export VAULT_MAX_RETRIES=2
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
vault-max-retries: 2
{{% /code-tab-content %}} {{% code-tab-content %}}
vault-max-retries = 2
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"vault-max-retries": 2
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
vault-client-timeout
Specifies the Vault client timeout.
Default: 60s
influxd flag | Environment variable | Configuration key |
---|---|---|
--vault-client-timeout |
VAULT_CLIENT_TIMEOUT |
vault-client-timeout |
influxd flag
influxd --vault-client-timeout=60s
Environment variable
export VAULT_CLIENT_TIMEOUT=60s
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
vault-client-timeout: 60s
{{% /code-tab-content %}} {{% code-tab-content %}}
vault-client-timeout = "60s"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"vault-client-timeout": "60s"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
vault-skip-verify
Skip certificate verification when communicating with Vault. Setting this variable voids Vault's security model and is not recommended.
Default: false
influxd flag | Environment variable | Configuration key |
---|---|---|
--vault-skip-verify |
VAULT_SKIP_VERIFY |
vault-skip-verify |
influxd flag
influxd --vault-skip-verify
Environment variable
export VAULT_SKIP_VERIFY=true
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
vault-skip-verify: true
{{% /code-tab-content %}} {{% code-tab-content %}}
vault-skip-verify = true
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"vault-skip-verify": true
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
vault-tls-server-name
Specifies the name to use as the Server Name Indication (SNI) host when connecting via TLS.
influxd flag | Environment variable | Configuration key |
---|---|---|
--vault-tls-server-name |
VAULT_TLS_SERVER_NAME |
vault-tls-server-name |
influxd flag
influxd --vault-tls-server-name=secure.example.com
Environment variable
export VAULT_TLS_SERVER_NAME=secure.example.com
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
vault-tls-server-name: secure.example.com
{{% /code-tab-content %}} {{% code-tab-content %}}
vault-tls-server-name = "secure.example.com"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"vault-tls-server-name": "secure.example.com"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
vault-token
Specifies the Vault authentication token use when authenticating with Vault.
influxd flag | Environment variable | Configuration key |
---|---|---|
--vault-token |
VAULT_TOKEN |
vault-token |
influxd flag
influxd --vault-token=exAmple-t0ken-958a-f490-c7fd0eda5e9e
Environment variable
export VAULT_TOKEN=exAmple-t0ken-958a-f490-c7fd0eda5e9e
Configuration file
{{< code-tabs-wrapper >}} {{% code-tabs %}} YAML TOML JSON {{% /code-tabs %}} {{% code-tab-content %}}
vault-token: exAmple-t0ken-958a-f490-c7fd0eda5e9e
{{% /code-tab-content %}} {{% code-tab-content %}}
vault-token = "exAmple-t0ken-958a-f490-c7fd0eda5e9e"
{{% /code-tab-content %}} {{% code-tab-content %}}
{
"vault-token": "exAmple-t0ken-958a-f490-c7fd0eda5e9e"
}
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}