Back to Influxdb

Index

content/shared/influxdb-v2/reference/cli/influx/setup/_index.md

latest2.9 KB
Original Source

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

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

Usage

influx setup [flags]

Flags

FlagDescriptionData type{{< cli/mapped >}}
-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

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

Examples

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