influx setup

  • influx CLI 2.0.0+
  • InfluxDB 2.0.0+
  • Updated in CLI v2.0.3

This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.

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

  1. 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

Start interactive InfluxDB setup
  1. influx setup
Set up InfluxDB with all required information and skip confirmation
  1. influx setup \
  2. --org example-org \
  3. --bucket example-bucket \
  4. --username example-user \
  5. --password ExAmPl3PA55W0rD \
  6. --force

get-started