Documentation

influx setup

Works with InfluxDB OSS 2.x

The influx setup command initiates the setup process for InfluxDB OSS 2.x instances. The command does not work with InfluxDB Cloud.

The influx setup command walks through the initial InfluxDB OSS setup process, creating a default user, organization, and bucket.

The Operator token created in the InfluxDB setup process has full read and write access to all organizations in the database.

Usage

influx setup [flags]

Flags

Flag Description Data type Maps to ?
-c --active-config CLI configuration to use for command string
-b --bucket Primary bucket name string
--configs-path Path to influx CLI configurations (default ~/.influxdbv2/configs) string INFLUX_CONFIGS_PATH
-f --force Skip confirmation prompt
-h --help Help for the setup command
--host HTTP address of InfluxDB (default http://localhost:8086) string INFLUX_HOST
--http-debug Inspect communication with InfluxDB servers. string
-o --org Primary organization name string
-p --password Password for primary user string
-r --retention Duration bucket will retain data (0 is infinite, default is 0) duration
--skip-verify Skip TLS certificate verification INFLUX_SKIP_VERIFY
-t --token Token for admin user (auto-generated by default) string INFLUX_TOKEN
-u --username Primary username string

Valid --retention units are nanoseconds (ns), microseconds (us or µs), milliseconds (ms), seconds (s), minutes (m), hours (h), days (d), and weeks (w).

Examples

Set up InfluxDB interactively with prompts for required information
influx setup
Set up InfluxDB with all required information and skip confirmation
influx setup \
  --org example-org \
  --bucket example-bucket \
  --username example-user \
  --password ExAmPl3PA55W0rD \
  --force  

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following:

InfluxDB Cloud Serverless