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

FlagDescriptionData typeMaps to ?
-c--active-configCLI configuration to use for commandstring
-b--bucketPrimary bucket namestring
--configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-f--forceSkip confirmation prompt
-h--helpHelp for the setup command
--hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
--http-debugInspect communication with InfluxDB servers.string
-o--orgPrimary organization namestring
-p--passwordPassword for primary userstring
-r--retentionDuration bucket will retain data (0 is infinite, default is 0)duration
--skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t--tokenToken for admin user (auto-generated by default)stringINFLUX_TOKEN
-u--usernamePrimary usernamestring

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 powered by TSM