Documentation

influx setup

This page documents an earlier version of InfluxDB. InfluxDB v2.6 is the latest stable version. View this page in the v2.6 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

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
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!


Set your InfluxDB URL

Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.