| title |
description |
menu |
weight |
influxdb/v2.0/tags |
related |
canonical |
| influx setup |
The `influx setup` command walks through the initial InfluxDB OSS setup process, creating a default user, organization, and bucket.
|
| influxdb_2_0_ref |
| name |
parent |
| influx setup |
influx |
|
|
101 |
|
| /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials |
| /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions |
|
/{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/ |
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
| Flag |
|
Description |
Data type |
{{< cli/mapped >}} |
-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 |
|
{{% 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
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