2019-01-22 21:35:11 +00:00
---
2020-04-16 17:37:01 +00:00
title: Get started with InfluxDB
2019-01-23 23:38:25 +00:00
description: Download, install, and setup InfluxDB, creating a default organization, user, and bucket.
2019-01-22 21:35:11 +00:00
menu:
2020-07-28 22:34:16 +00:00
influxdb_2_0:
2019-01-22 21:35:11 +00:00
name: Get started
2020-07-28 21:59:56 +00:00
weight: 1
v2.0/tags: [get-started, install]
2020-04-21 18:23:52 +00:00
aliases:
- /v2.0/cloud/get-started
2020-07-28 21:59:56 +00:00
- /v2.0/get-started
2019-01-22 21:35:11 +00:00
---
2020-04-21 18:23:52 +00:00
The InfluxDB 2.0 time series platform is purpose-built to collect, store,
process and visualize metrics and events.
Start with **InfluxDB Cloud 2.0** , a fully managed and hosted version of InfluxDB 2.0,
or **InfluxDB OSS 2.0 _(beta)_** , the open source
version of InfluxDB 2.0.
2020-04-17 17:41:00 +00:00
2020-04-22 21:01:04 +00:00
< div class = "get-started-btns" >
2020-04-21 18:23:52 +00:00
< a class = "btn" href = "#start-with-influxdb-cloud-2-0" > Start with InfluxDB Cloud< / a >
2020-04-23 21:09:30 +00:00
< a class = "btn" href = "#start-with-influxdb-oss" > Start with InfluxDB OSS < span class = "oss" > < / span > < / a >
2020-04-22 21:01:04 +00:00
< / div >
2020-04-16 17:37:01 +00:00
2020-04-21 18:23:52 +00:00
_See [Differences between InfluxDB Cloud and InfluxDB OSS ](#differences-between-influxdb-cloud-and-influxdb-oss )._
2020-04-22 21:01:04 +00:00
---
2020-04-21 18:23:52 +00:00
## Start with InfluxDB Cloud 2.0
2020-04-16 17:37:01 +00:00
2020-04-16 20:10:50 +00:00
### Start for free
2020-04-16 17:37:01 +00:00
2020-04-22 21:32:04 +00:00
Start using {{< cloud-name > }} at no cost with the [Free Plan ](/v2.0/account-management/pricing-plans/#free-plan ).
2020-04-16 17:37:01 +00:00
Use it as much and as long as you like within the plan's rate-limits.
Limits are designed to let you monitor 5-10 sensors, stacks or servers comfortably.
2020-04-16 20:10:50 +00:00
### Sign up
2020-04-16 17:37:01 +00:00
1. Choose one of the following:
- **Subscribe through InfluxData**
To subscribe to an InfluxDB Cloud 2.0 **Free Plan** through InfluxData,
2020-05-20 19:17:47 +00:00
go to [InfluxDB Cloud 2.0 ]({{< cloud-link >}} ).
- To use social sign-on, click **Continue with Google** . Note that Google social sign-on does not support email aliases.
- Sign up with email by entering your name, email address, and password, then click **Create Account** .
If you originally signed up with email but want to enable social sign-on, you can do so by logging in through Google as long as you use the same email address.
2020-04-16 17:37:01 +00:00
- **Subscribe through a cloud provider**
To subscribe to an InfluxDB Cloud **Usage-Based** plan and pay through your
**Amazon Web Services (AWS)** or **Google Cloud Platform (GCP)** account:
- **AWS**
Sign in to AWS, navigate to the [InfluxDB Cloud product on AWS Marketplace ](https://aws.amazon.com/marketplace/pp/B08234JZPS ),
and follow the prompts to subscribe. After you click **Set Up Your Account** ,
enter your credentials, and then click **Start Now** .
All usage charges will be paid through the subscribed AWS account.
- **GCP**
Sign in to GCP, navigate to the [InfluxDB Cloud product on GCP Marketplace ](https://console.cloud.google.com/marketplace/details/influxdata-public/cloud2-gcp-marketplace-prod ),
and follow the prompts to subscribe. After you click **Set Up Your Account** ,
enter your credentials, and then click **Start Now** .
All usage charges will be paid through the subscribed GCP account.
{{%note%}}
Currently, we do **not support** using an existing InfluxDB Cloud 2.0 account to sign up for an InfluxDB Cloud 2.0 plan through AWS or GCP Marketplaces.
{{%/note%}}
2020-05-20 19:17:47 +00:00
2. If you signed up with your email address, InfluxDB Cloud requires email verification to complete the sign up process.
2020-04-16 17:37:01 +00:00
Verify your email address by opening the email sent to the address you provided and clicking **Verify Your Email** .
3. (If you subscribed through InfluxData) Choose your cloud provider.
4. Select a provider and region for your {{< cloud-name > }} instance. The following are available:
2020-05-15 18:04:24 +00:00
{{< cloud_regions type = "list" > }}
2020-04-16 17:37:01 +00:00
_To suggest regions to add, click **Let us know** under Regions._
5. (If you subscribed through InfluxData) Review the terms of the agreement, and then select **I have viewed and agree to InfluxDB Cloud 2.0 Services Subscription Agreement and InfluxData Global Data Processing Agreement** .
For details on the agreements, see the [InfluxDB Cloud 2.0: Services Subscription Agreement ](https://www.influxdata.com/legal/terms-of-use/ ) and the [InfluxData Global Data Processing Agreement ](https://www.influxdata.com/legal/influxdata-global-data-processing-agreement/ ).
6. Click **Finish** . {{< cloud-name > }} opens with a default organization and bucket (both created from your email address).
_To update organization and bucket names, see [Update an organization ](/v2.0/organizations/update-org/ )
and [Update a bucket ](/v2.0/organizations/buckets/update-bucket/#update-a-bucket-s-name-in-the-influxdb-ui )._
2019-01-22 23:31:35 +00:00
2020-04-22 17:05:44 +00:00
{{% cloud %}}
2020-04-16 17:37:01 +00:00
All InfluxDB 2.0 documentation applies to {{< cloud-name " short " > }} unless otherwise specified.
References to the InfluxDB user interface (UI) or localhost:9999 refer to your
{{< cloud-name > }} UI.
2020-04-22 17:05:44 +00:00
{{% /cloud %}}
2019-03-19 23:02:43 +00:00
2020-07-28 21:59:56 +00:00
### (Optional) Download and install the influx CLI
2020-06-16 17:28:52 +00:00
2020-06-18 21:25:33 +00:00
To use the `influx` CLI to manage and interact with your InfluxDB Cloud instance, complete the following steps:
2020-06-16 17:28:52 +00:00
{{< tabs-wrapper > }}
{{% tabs %}}
[macOS ](# )
[Linux ](# )
{{% /tabs %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BEGIN macOS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
{{% tab-content %}}
2020-07-28 21:59:56 +00:00
#### Download influx CLI for macOS
2020-06-16 17:28:52 +00:00
Click the following button to download and install `influx` CLI for macOS.
2020-08-06 17:52:42 +00:00
< a class = "btn download" href = "https://dl.influxdata.com/influxdb/releases/influxdb_client_2.0.0-beta.16_darwin_amd64.tar.gz" download > influx CLI (macOS)< / a >
2020-06-16 17:28:52 +00:00
2020-07-28 21:59:56 +00:00
#### Unpackage the influx binary
2020-06-16 17:28:52 +00:00
2020-06-18 23:26:29 +00:00
**Note:** The commands below are examples. Adjust the file names, paths, and utilities to your own needs.
2020-06-16 17:28:52 +00:00
To unpackage the downloaded archive, **double click the archive file in Finder**
or run the following command in a macOS command prompt application such
**Terminal** or ** [iTerm2 ](https://www.iterm2.com/ )**:
```sh
# Unpackage contents to the current working directory
2020-08-06 17:52:42 +00:00
tar zxvf ~/Downloads/influxdb_client_2.0.0-beta.16_darwin_amd64.tar.gz
2020-06-16 17:28:52 +00:00
```
2020-07-28 21:59:56 +00:00
#### (Optional) Place the binary in your $PATH
2020-06-16 17:28:52 +00:00
If you choose, you can place `influx` in your `$PATH` or you can
2020-06-18 23:26:29 +00:00
prefix the executable with `./` to run in place. If the binary is on your $PATH, you can run `influx` from any directory. Otherwise, you must specify the location of the CLI (for example, `./influx` or `path/to/influx` ).
**Note:** If you have the 1.x binary on your $PATH, moving the 2.0 binary to your $PATH will overwrite the 1.x binary because they have the same name.
2020-06-16 17:28:52 +00:00
```sh
2020-06-18 23:26:29 +00:00
# Copy the influx binary to your $PATH
2020-08-06 17:52:42 +00:00
sudo cp influxdb_client_2.0.0-beta.16_darwin_amd64/influx /usr/local/bin/
2020-06-16 17:28:52 +00:00
```
{{% note %}}
If you rename the binary, all references to `influx` in this documentation refer to the renamed binary.
{{% /note %}}
2020-07-28 21:59:56 +00:00
##### Run influx CLI on macOS Catalina
2020-06-16 17:28:52 +00:00
2020-06-18 23:26:29 +00:00
If you're running `influx` on macOS Catalina, you must [manually authorize the InfluxDB binaries ](/v2.0/get-started/#run-influxdb-on-macos-catalina ).
2020-06-16 17:28:52 +00:00
2020-07-28 21:59:56 +00:00
Now, you're ready to [Use the influx CLI ](#use-the-influx-cli ).
2020-06-18 21:25:33 +00:00
2020-06-16 17:28:52 +00:00
{{% /tab-content %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END macOS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BEGIN Linux - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
{{% tab-content %}}
2020-07-28 21:59:56 +00:00
#### Download influx CLI for Linux
2020-06-16 17:28:52 +00:00
2020-06-18 23:26:29 +00:00
Click one of the following buttons to download and install the `influx` CLI appropriate for your chipset.
2020-06-16 17:28:52 +00:00
2020-08-06 17:52:42 +00:00
< a class = "btn download" href = "https://dl.influxdata.com/influxdb/releases/influxdb_client_2.0.0-beta.16_linux_amd64.tar.gz" download > influx CLI (amd64)< / a >
< a class = "btn download" href = "https://dl.influxdata.com/influxdb/releases/influxdb_client_2.0.0-beta.16_linux_arm64.tar.gz" download > influx CLI (arm)< / a >
2020-06-16 17:28:52 +00:00
2020-07-28 21:59:56 +00:00
#### Unpackage the influx binary
2020-06-16 17:28:52 +00:00
2020-06-18 23:26:29 +00:00
**Note:** The commands below are examples. Adjust the file names, paths, and utilities to your own needs.
2020-06-16 17:28:52 +00:00
```sh
# Unpackage contents to the current working directory
2020-08-06 17:52:42 +00:00
tar xvfz influxdb_client_2.0.0-beta.16_linux_amd64.tar.gz
2020-06-18 23:26:29 +00:00
```
2020-07-28 21:59:56 +00:00
#### (Optional) Place the binary in your $PATH
2020-06-16 17:28:52 +00:00
2020-06-18 23:26:29 +00:00
If you choose, you can place `influx` in your `$PATH` or you can
2020-06-25 19:58:12 +00:00
prefix the executable with `./` to run in place. If the binary is on your $PATH, you can run `influx` from any directory. Otherwise, you must specify the location of the CLI (for example, `./influx` or `path/to/influx` ).
2020-06-18 23:26:29 +00:00
**Note:** If you have the 1.x binary on your $PATH, moving the 2.0 binary to your $PATH will overwrite the 1.x binary because they have the same name.
```sh
2020-06-16 17:28:52 +00:00
# Copy the influx and influxd binary to your $PATH
2020-08-06 17:52:42 +00:00
sudo cp influxdb_client_2.0.0-beta.16_linux_amd64/influx /usr/local/bin/
2020-06-16 17:28:52 +00:00
```
{{% note %}}
If you rename the binary, all references to `influx` in this documentation refer to the renamed binary.
{{% /note %}}
2020-07-28 21:59:56 +00:00
Now, you're ready to [Use the influx CLI ](#use-the-influx-cli ).
2020-06-18 21:25:33 +00:00
2020-06-16 17:28:52 +00:00
{{% /tab-content %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END Linux - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
{{< / tabs-wrapper > }}
2020-04-16 20:10:50 +00:00
### Sign in
2020-04-16 17:37:01 +00:00
Sign in to [InfluxDB Cloud 2.0 ](https://cloud2.influxdata.com ) using your email address and password.
< a class = "btn" href = "https://cloud2.influxdata.com" > Sign in to InfluxDB Cloud 2.0 now< / a >
2020-04-21 18:23:52 +00:00
### Start working with your time series data
2020-06-18 21:25:33 +00:00
2020-04-21 18:23:52 +00:00
With {{< cloud-name " short " > }} setup, see [Next steps ](#next-steps ) for what to do next.
2020-04-16 17:37:01 +00:00
2020-04-21 18:23:52 +00:00
---
2020-04-16 17:37:01 +00:00
2020-04-21 18:23:52 +00:00
## Start with InfluxDB OSS
2020-04-16 17:37:01 +00:00
Get started with InfluxDB OSS v2.0 by downloading InfluxDB, installing the necessary
executables, and running the initial setup process.
2019-01-23 23:38:25 +00:00
{{< tabs-wrapper > }}
{{% tabs %}}
[macOS ](# )
[Linux ](# )
[Docker ](# )
2019-12-03 17:59:28 +00:00
[Kubernetes ](# )
2019-01-23 23:38:25 +00:00
{{% /tabs %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BEGIN macOS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
{{% tab-content %}}
2019-12-30 21:27:18 +00:00
### Download and install InfluxDB v2.0 beta
2020-06-18 21:25:33 +00:00
2019-12-30 21:27:18 +00:00
Download InfluxDB v2.0 beta for macOS.
2019-01-23 23:38:25 +00:00
2020-08-06 17:52:42 +00:00
< a class = "btn download" href = "https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.16_darwin_amd64.tar.gz" download > InfluxDB v2.0 beta (macOS)< / a >
2019-01-23 23:38:25 +00:00
2019-04-24 22:20:55 +00:00
### Unpackage the InfluxDB binaries
2020-06-18 21:25:33 +00:00
2019-10-18 16:30:10 +00:00
To unpackage the downloaded archive, **double click the archive file in Finder**
2019-10-18 19:37:39 +00:00
or run the following command in a macOS command prompt application such
**Terminal** or ** [iTerm2 ](https://www.iterm2.com/ )**:
2019-01-23 23:38:25 +00:00
```sh
2019-01-24 20:45:22 +00:00
# Unpackage contents to the current working directory
2020-08-06 17:52:42 +00:00
tar zxvf ~/Downloads/influxdb_2.0.0-beta.16_darwin_amd64.tar.gz
2019-04-24 22:20:55 +00:00
```
2019-01-24 20:45:22 +00:00
2019-10-18 16:30:10 +00:00
#### (Optional) Place the binaries in your $PATH
2020-06-18 21:25:33 +00:00
2019-10-18 16:30:10 +00:00
If you choose, you can place `influx` and `influxd` in your `$PATH` or you can
prefix the executables with `./` to run then in place.
2019-01-24 20:45:22 +00:00
2019-04-24 22:20:55 +00:00
```sh
# (Optional) Copy the influx and influxd binary to your $PATH
2020-08-06 17:52:42 +00:00
sudo cp influxdb_2.0.0-beta.16_darwin_amd64/{influx,influxd} /usr/local/bin/
2019-01-23 23:38:25 +00:00
```
2019-01-24 20:45:22 +00:00
{{% note %}}
Both InfluxDB 1.x and 2.x include `influx` and `influxd` binaries.
If InfluxDB 1.x binaries are already in your `$PATH` , run the 2.0 binaries in place
or rename them before putting them in your `$PATH` .
If you rename the binaries, all references to `influx` and `influxd` in this documentation refer to your renamed binaries.
{{% /note %}}
2020-04-21 18:23:52 +00:00
#### Networking ports
2020-06-18 21:25:33 +00:00
2019-04-18 14:59:43 +00:00
By default, InfluxDB uses TCP port `9999` for client-server communication over
the [InfluxDB HTTP API ](/v2.0/reference/api/ ).
2019-01-23 23:38:25 +00:00
2020-04-21 18:23:52 +00:00
### Start InfluxDB
2020-06-18 21:25:33 +00:00
2019-01-23 23:38:25 +00:00
Start InfluxDB by running the `influxd` daemon:
```bash
influxd
```
2019-11-14 11:23:37 +00:00
{{% warn %}}
2019-11-14 18:58:24 +00:00
#### Run InfluxDB on macOS Catalina
2020-06-18 21:25:33 +00:00
2019-11-14 18:58:24 +00:00
macOS Catalina requires downloaded binaries to be signed by registered Apple developers.
Currently, when you first attempt to run `influxd` or `influx` , macOS will prevent it from running.
To manually authorize the InfluxDB binaries:
1. Attempt to run the `influx` or `influxd` commands.
2019-12-04 17:07:45 +00:00
2. Open **System Preferences** and click **Security & Privacy** .
2019-11-14 18:58:24 +00:00
3. Under the **General** tab, there is a message about `influxd` or `influx` being blocked.
Click **Open Anyway** .
4. Repeat this process for both binaries.
We are in the process of updating our build process to ensure released binaries are signed by InfluxData.
2019-11-14 11:23:37 +00:00
{{% /warn %}}
2019-01-23 23:38:25 +00:00
_See the [`influxd` documentation ](/v2.0/reference/cli/influxd ) for information about
available flags and options._
2020-04-28 18:04:33 +00:00
### Enable shell completion (Optional)
2020-04-28 21:58:12 +00:00
To install `influx` shell completion scripts, see [`influx completion` ](/v2.0/reference/cli/influx/completion/#install-completion-scripts ).
2020-04-28 18:04:33 +00:00
2019-01-23 23:38:25 +00:00
{{% note %}}
#### InfluxDB "phone home"
2020-06-18 21:25:33 +00:00
2019-01-23 23:38:25 +00:00
By default, InfluxDB sends telemetry data back to InfluxData.
The [InfluxData telemetry ](https://www.influxdata.com/telemetry ) page provides
information about what data is collected and how it is used.
2019-02-19 16:38:48 +00:00
To opt-out of sending telemetry data back to InfluxData, include the
2019-01-23 23:38:25 +00:00
`--reporting-disabled` flag when starting `influxd` .
```bash
influxd --reporting-disabled
```
{{% /note %}}
{{% /tab-content %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END macOS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BEGIN Linux - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
{{% tab-content %}}
2019-12-30 21:27:18 +00:00
### Download and install InfluxDB v2.0 beta
2020-06-18 21:25:33 +00:00
2019-12-30 21:27:18 +00:00
Download the InfluxDB v2.0 beta package appropriate for your chipset.
2019-01-23 23:38:25 +00:00
2020-08-06 17:52:42 +00:00
< a class = "btn download" href = "https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.16_linux_amd64.tar.gz" download > InfluxDB v2.0 beta (amd64)< / a >
< a class = "btn download" href = "https://dl.influxdata.com/influxdb/releases/influxdb_2.0.0-beta.16_linux_arm64.tar.gz" download > InfluxDB v2.0 beta (arm)< / a >
2019-01-23 23:38:25 +00:00
### Place the executables in your $PATH
2020-06-18 21:25:33 +00:00
2019-01-24 20:45:22 +00:00
Unpackage the downloaded archive and place the `influx` and `influxd` executables in your system `$PATH` .
_**Note:** The following commands are examples. Adjust the file names, paths, and utilities to your own needs._
2019-01-23 23:38:25 +00:00
```sh
2019-01-24 20:45:22 +00:00
# Unpackage contents to the current working directory
2020-08-06 17:52:42 +00:00
tar xvzf path/to/influxdb_2.0.0-beta.16_linux_amd64.tar.gz
2019-01-24 20:45:22 +00:00
# Copy the influx and influxd binary to your $PATH
2020-08-06 17:52:42 +00:00
sudo cp influxdb_2.0.0-beta.16_linux_amd64/{influx,influxd} /usr/local/bin/
2019-01-23 23:38:25 +00:00
```
2019-01-24 20:45:22 +00:00
{{% note %}}
Both InfluxDB 1.x and 2.x include `influx` and `influxd` binaries.
If InfluxDB 1.x binaries are already in your `$PATH` , run the 2.0 binaries in place
or rename them before putting them in your `$PATH` .
If you rename the binaries, all references to `influx` and `influxd` in this documentation refer to your renamed binaries.
{{% /note %}}
2020-04-21 18:23:52 +00:00
#### Networking ports
2020-06-18 21:25:33 +00:00
2019-04-18 14:59:43 +00:00
By default, InfluxDB uses TCP port `9999` for client-server communication over
the [InfluxDB HTTP API ](/v2.0/reference/api/ ).
2019-01-23 23:38:25 +00:00
2020-04-21 18:23:52 +00:00
### Start InfluxDB
2020-06-18 21:25:33 +00:00
2019-01-23 23:38:25 +00:00
Start InfluxDB by running the `influxd` daemon:
```bash
influxd
```
_See the [`influxd` documentation ](/v2.0/reference/cli/influxd ) for information about
available flags and options._
2020-04-28 18:04:33 +00:00
### Enable shell completion (Optional)
2020-04-28 21:58:12 +00:00
To install `influx` shell completion scripts, see [`influx completion` ](/v2.0/reference/cli/influx/completion/#install-completion-scripts ).
2020-04-28 18:04:33 +00:00
2019-01-23 23:38:25 +00:00
{{% note %}}
#### InfluxDB "phone home"
2020-06-18 21:25:33 +00:00
2019-01-23 23:38:25 +00:00
By default, InfluxDB sends telemetry data back to InfluxData.
The [InfluxData telemetry ](https://www.influxdata.com/telemetry ) page provides
information about what data is collected and how it is used.
2019-02-19 16:38:48 +00:00
To opt-out of sending telemetry data back to InfluxData, include the
2019-01-23 23:38:25 +00:00
`--reporting-disabled` flag when starting `influxd` .
```bash
influxd --reporting-disabled
```
{{% /note %}}
{{% /tab-content %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END Linux - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BEGIN Docker - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
{{% tab-content %}}
2019-12-30 21:27:18 +00:00
### Download and run InfluxDB v2.0 beta
2020-06-18 21:25:33 +00:00
2019-12-30 21:27:18 +00:00
Use `docker run` to download and run the InfluxDB v2.0 beta Docker image.
2019-04-18 14:59:43 +00:00
Expose port `9999` , which InfluxDB uses for client-server communication over
the [InfluxDB HTTP API ](/v2.0/reference/api/ ).
2019-01-23 23:38:25 +00:00
```sh
2020-02-03 21:48:11 +00:00
docker run --name influxdb -p 9999:9999 quay.io/influxdb/influxdb:2.0.0-beta
2019-01-23 23:38:25 +00:00
```
2020-02-06 22:14:35 +00:00
_To run InfluxDB in [detached mode ](https://docs.docker.com/engine/reference/run/#detached-vs-foreground ), include the `-d` flag in the `docker run` command._
2020-02-03 21:48:11 +00:00
2019-01-23 23:38:25 +00:00
{{% note %}}
#### InfluxDB "phone home"
2020-06-18 21:25:33 +00:00
2019-01-23 23:38:25 +00:00
By default, InfluxDB sends telemetry data back to InfluxData.
The [InfluxData telemetry ](https://www.influxdata.com/telemetry ) page provides
information about what data is collected and how it is used.
2019-02-19 16:38:48 +00:00
To opt-out of sending telemetry data back to InfluxData, include the
2019-01-23 23:38:25 +00:00
`--reporting-disabled` flag when starting the InfluxDB container.
```bash
2019-12-30 21:27:18 +00:00
docker run -p 9999:9999 quay.io/influxdb/influxdb:2.0.0-beta --reporting-disabled
2019-01-23 23:38:25 +00:00
```
{{% /note %}}
### Console into the InfluxDB Container (Optional)
2020-06-18 21:25:33 +00:00
2019-01-23 23:50:34 +00:00
To use the `influx` command line interface, console into the `influxdb` Docker container:
2019-01-23 23:38:25 +00:00
```bash
docker exec -it influxdb /bin/bash
```
{{% /tab-content %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END Docker - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
2019-12-03 17:59:28 +00:00
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BEGIN kubernetes - - - - - - - - - - - - - - - - - - - - - - - - - - -->
{{% tab-content %}}
2019-12-16 20:13:19 +00:00
### Install InfluxDB in a Kubernetes cluster
2019-12-03 17:59:28 +00:00
2019-12-17 20:10:28 +00:00
{{% note %}}
2019-12-16 20:13:19 +00:00
The instructions below use Minikube, but the steps should be similar in any Kubernetes cluster.
2019-12-17 20:10:28 +00:00
{{% /note %}}
2019-12-03 17:59:28 +00:00
2019-12-16 20:13:19 +00:00
1. [Install Minikube ](https://kubernetes.io/docs/tasks/tools/install-minikube/ ).
2019-12-03 17:59:28 +00:00
2019-12-16 20:13:19 +00:00
2. Start Minikube:
2019-12-03 17:59:28 +00:00
2020-04-21 18:23:52 +00:00
```sh
2019-12-03 17:59:28 +00:00
minikube start
```
2019-12-17 20:49:46 +00:00
3. Apply the [sample InfluxDB configuration ](https://github.com/influxdata/docs-v2/blob/master/static/downloads/influxdb-k8-minikube.yaml ) by running:
2019-12-03 17:59:28 +00:00
2020-04-21 18:23:52 +00:00
```sh
2019-12-17 20:49:46 +00:00
kubectl apply -f https://raw.githubusercontent.com/influxdata/docs-v2/master/static/downloads/influxdb-k8-minikube.yaml
2019-12-03 17:59:28 +00:00
```
2020-01-09 22:24:19 +00:00
< div class = "warn block" >
< p >
Always inspect YAML manifests before running < code > kubectl apply -f < url> < / code > !
< / p >
< / div >
2019-12-17 20:49:46 +00:00
2020-01-09 22:31:30 +00:00
This creates an `influxdb` Namespace, Service, and StatefulSet.
A PersistentVolumeClaim is also created to store data written to InfluxDB.
2019-12-20 18:47:29 +00:00
4. Ensure the Pod is running:
2019-12-17 18:19:24 +00:00
2020-04-21 18:23:52 +00:00
```sh
2019-12-17 18:19:24 +00:00
kubectl get pods -n influxdb
```
2019-12-18 10:12:52 +00:00
2019-12-20 18:47:29 +00:00
5. Ensure the Service is available:
2019-12-03 17:59:28 +00:00
2020-04-21 18:23:52 +00:00
```sh
2019-12-18 10:12:52 +00:00
kubectl describe service -n influxdb influxdb
2019-12-03 17:59:28 +00:00
```
2019-12-18 17:42:20 +00:00
You should see an IP address after `Endpoints` in the command's output.
2019-12-17 20:49:46 +00:00
6. Forward port 9999 from inside the cluster to localhost:
2019-12-03 17:59:28 +00:00
2020-04-21 18:23:52 +00:00
```sh
2019-12-18 17:42:20 +00:00
kubectl port-forward -n influxdb service/influxdb 9999:9999
2019-12-13 17:55:34 +00:00
```
2019-12-16 16:00:04 +00:00
2019-12-03 17:59:28 +00:00
{{% /tab-content %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END kubernetes - - - - - - - - - - - - - - - - - - - - - - - - - - -->
2019-01-23 23:38:25 +00:00
{{< / tabs-wrapper > }}
2019-03-19 23:02:43 +00:00
## Set up InfluxDB
2020-06-18 21:25:33 +00:00
2019-01-23 23:38:25 +00:00
The initial setup process for InfluxDB walks through creating a default organization,
user, and bucket.
The setup process is available in both the InfluxDB user interface (UI) and in
the `influx` command line interface (CLI).
{{< tabs-wrapper > }}
{{% tabs %}}
[UI Setup ](# )
[CLI Setup ](# )
{{% /tabs %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BEGIN UI Setup - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
{{% tab-content %}}
### Set up InfluxDB through the UI
2019-01-23 23:50:34 +00:00
1. With InfluxDB running, visit [localhost:9999 ](http://localhost:9999 ).
2019-01-23 23:38:25 +00:00
2. Click **Get Started**
#### Set up your initial user
1. Enter a **Username** for your initial user.
2. Enter a **Password** and **Confirm Password** for your user.
3. Enter your initial **Organization Name** .
4. Enter your initial **Bucket Name** .
5. Click **Continue** .
InfluxDB is now initialized with a primary user, organization, and bucket.
2019-05-03 19:43:28 +00:00
You are ready to [write or collect data ](/v2.0/write-data ).
2019-01-23 23:38:25 +00:00
2020-07-28 21:59:56 +00:00
{{% note %}}
#### Use the influx CLI
2020-06-18 21:25:33 +00:00
2020-07-28 21:59:56 +00:00
To use the [`influx` CLI ](/v2.0/reference/cli/influx ) after setting up InfluxDB, provide your [authentication token ](/v2.0/users/tokens/ ), which is automatically generated during the setup process. For instructions on viewing your token via CLI or UI, see [View tokens ](/v2.0/security/tokens/view-tokens/ ).
2019-04-01 22:19:13 +00:00
2020-07-28 21:59:56 +00:00
Use one of the following methods to provide your authentication token to the CLI:
2019-04-01 22:19:13 +00:00
2020-07-28 21:59:56 +00:00
- Create a new InfluxDB connection configuration using the [`influx config create` command ](/v2.0/reference/cli/influx/config/create/ ).
- Pass your token to the `influx` CLI using the `-t` or `--token` flag.
- Set the `INFLUX_TOKEN` environment variable using your token.
2020-04-09 09:25:51 +00:00
2020-07-28 21:59:56 +00:00
```bash
export INFLUX_TOKEN=oOooYourAuthTokenOoooOoOO==
```
2019-04-01 22:19:13 +00:00
2020-07-28 21:59:56 +00:00
_See [View tokens ](/v2.0/security/tokens/view-tokens/ ) for information about
retrieving authentication tokens._
{{% /note %}}
2019-04-01 22:19:13 +00:00
2019-01-23 23:38:25 +00:00
{{% /tab-content %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END UI Setup - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - BEGIN CLI Setup - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
{{% tab-content %}}
### Set up InfluxDB through the influx CLI
2020-06-18 21:25:33 +00:00
2019-01-23 23:38:25 +00:00
Begin the InfluxDB setup process via the `influx` CLI by running:
```bash
influx setup
```
1. Enter a **primary username** .
2. Enter a **password** for your user.
3. **Confirm your password** by entering it again.
4. Enter a name for your **primary organization** .
5. Enter a name for your **primary bucket** .
2020-06-23 05:48:46 +00:00
6. Enter a **retention period** for your primary bucket—valid units are nanoseconds (`ns`), microseconds (`us` or `µs` ), milliseconds (`ms`), seconds (`s`), minutes (`m`), hours (`h`), days (`d`), and weeks (`w`). Enter nothing for an infinite retention period.
2019-01-23 23:38:25 +00:00
7. Confirm the details for your primary user, organization, and bucket.
2020-06-18 21:25:33 +00:00
InfluxDB is now initialized with a primary user, organization, bucket, and authentication token. InfluxDB also creates a configuration profile for you so that you don't have to add organization and token to every command. To view that config profile, use the [`influx config list` ](/v2.0/reference/cli/influx/config ) command.
2020-05-20 21:06:20 +00:00
2020-05-20 21:11:42 +00:00
To continue to use InfluxDB via the CLI, you need the authentication token created during setup. To view the token, log into the UI with the credentials created above. (For instructions, see [View tokens in the InfluxDB UI ](/v2.0/security/tokens/view-tokens/#view-tokens-in-the-influxdb-ui ).)
2020-05-20 21:06:20 +00:00
2019-05-03 19:43:28 +00:00
You are ready to [write or collect data ](/v2.0/write-data ).
2019-01-23 23:38:25 +00:00
2020-03-06 21:29:24 +00:00
{{% note %}}
To automate the setup process, use [flags ](/v2.0/reference/cli/influx/setup/#flags )
to provide the required information.
{{% /note %}}
2019-01-23 23:38:25 +00:00
{{% /tab-content %}}
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END UI Setup - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
{{< / tabs-wrapper > }}
2020-04-21 18:23:52 +00:00
---
## Next Steps
### Collect and write data
Collect and write data to InfluxDB using the Telegraf plugins, the InfluxDB v2 API, the `influx`
command line interface (CLI), the InfluxDB UI (the user interface for InfluxDB 2.0), or the InfluxDB v2 API client libraries.
#### Use Telegraf
Use Telegraf to quickly write data to {{< cloud-name > }}.
Create new Telegraf configurations automatically in the InfluxDB UI, or manually update an
existing Telegraf configuration to send data to your {{< cloud-name " short " > }} instance.
2020-07-23 20:25:40 +00:00
For details, see [Automatically configure Telegraf ](/v2.0/write-data/no-code/use-telegraf/auto-config/ )
and [Manually update Telegraf configurations ](/v2.0/write-data/no-code/use-telegraf/manual-config/ ).
2020-04-21 18:23:52 +00:00
#### Scrape data
**InfluxDB OSS** lets you scrape Prometheus-formatted metrics from HTTP endpoints.
2020-07-02 22:12:01 +00:00
For details, see [Scrape data ](/v2.0/write-data/no-code/scrape-data/ ).
2020-04-21 18:23:52 +00:00
#### API, CLI, and client libraries
For information about using the InfluxDB v2 API, `influx` CLI, and client libraries to write data,
see [Write data to InfluxDB ](/v2.0/write-data/ ).
2020-04-30 23:04:28 +00:00
#### Demo data
2020-06-23 19:54:02 +00:00
If using ** {{< cloud-name " short " > }}**, [add a demo data bucket ](/v2.0/reference/sample-data/#influxdb-cloud-demo-data )
2020-05-14 20:51:33 +00:00
for quick, **free** access to time series data.
2020-04-30 23:04:28 +00:00
2020-04-21 18:23:52 +00:00
### Query data
Query data using Flux, the UI, and the `influx` command line interface.
See [Query data ](/v2.0/query-data/ ).
### Process data
Use InfluxDB tasks to process and downsample data. See [Process data ](/v2.0/process-data/ ).
### Visualize data
Build custom dashboards to visualize your data.
See [Visualize data ](/v2.0/visualize-data/ ).
### Monitor and alert
Monitor your data and sends alerts based on specified logic.
See [Monitor and alert ](/v2.0/monitor-alert/ ).
## Differences between InfluxDB Cloud and InfluxDB OSS
{{< cloud-name > }} is API-compatible and functionally compatible with InfluxDB OSS 2.0.
The primary differences between InfluxDB OSS 2.0 and InfluxDB Cloud 2.0 are:
2020-07-02 22:12:01 +00:00
- [InfluxDB scrapers ](/v2.0/write-data/no-code/scrape-data/ ) that collect data from specified
2020-04-21 18:23:52 +00:00
targets are not available in {{< cloud-name " short " > }}.
2020-05-27 15:39:47 +00:00
- {{< cloud-name " short " > }} instances are currently limited to a single organization.
2020-04-21 18:23:52 +00:00
#### New features in InfluxDB Cloud 2.0
- **Free Plan (rate-limited)**: Skip downloading and installing InfluxDB 2.0 and
2020-04-22 17:23:49 +00:00
jump into exploring InfluxDB 2.0 technology.
2020-04-21 18:23:52 +00:00
The Free Plan is designed for getting started with InfluxDB and for small hobby projects.
- **Flux support**: [Flux ](/v2.0/query-data/get-started/ ) is a standalone data
scripting and query language that increases productivity and code reuse.
It is the primary language for working with data within InfluxDB 2.0.
2020-04-22 17:23:49 +00:00
Flux can be used with other data sources as well, letting you work with data where it resides.
2020-04-21 18:23:52 +00:00
- **Unified API**: Everything in InfluxDB (ingest, query, storage, and visualization)
is now accessible using a unified [InfluxDB v2 API ](/v2.0/reference/api/ ) that
enables seamless movement between open source and cloud.
- **Integrated visualization and dashboards**: Based on the pioneering Chronograf project,
the new user interface (InfluxDB UI) offers quick and effortless onboarding,
richer user experiences, and significantly quicker results.
2020-04-22 21:32:04 +00:00
- **Usage-based pricing**: The [Usage-based Plan ](/v2.0/account-management/pricing-plans/#usage-based-plan )
2020-04-21 18:23:52 +00:00
offers more flexibility and ensures that you only pay for what you use.