added install and setup docs

pull/24/head
Scott Anderson 2019-01-22 15:46:25 -07:00
parent 3ff814298b
commit b7ac4f02c3
4 changed files with 56 additions and 14 deletions

View File

@ -20,3 +20,7 @@ Place the `influx` and `influxd` executables in your system `$PATH`.
### Networking ports ### Networking ports
By default, InfluxDB uses TCP port `9999` for client-server communication over InfluxDBs HTTP API. By default, InfluxDB uses TCP port `9999` for client-server communication over InfluxDBs HTTP API.
<div class="page-nav-btns">
<a class="btn next" href="/v2.0/get-started/setup/">Setup InfluxDB</a>
</div>

View File

@ -1,7 +1,7 @@
--- ---
title: Set up InfluxDB title: Set up InfluxDB
seotitle: Run the initial InfluxDB setup process seotitle: Run the initial InfluxDB setup process
description: placeholder description: The initial setup process for walks through creating a default organization, user, and bucket.
menu: menu:
v2_0: v2_0:
name: Set up InfluxDB name: Set up InfluxDB
@ -9,18 +9,54 @@ menu:
weight: 2 weight: 2
--- ---
To setup InfluxDB for the first time, you must create a default organization, user, and bucket. The initial setup process for InfluxDB walks through creating a default organization,
InfluxDB provides a one-time setup process that does all of these things. user, and bucket.
The setup process is available in both the InfluxDB user interface (UI) and in The setup process is available in both the InfluxDB user interface (UI) and in
the `influx` command line interface (CLI). the `influx` command line interface (CLI).
The setup API is only available on an uninitialized InfluxDB installation. ## Start the influxd daemon
In order to setup InfluxDB via the UI or the CLI, first start the `influxd` daemon by running:
## Through the UI ```bash
- start `influxd` influxd
- Visit [localhost:9999](http://localhost:9999) ```
_See the [`influxd` documentation](/v2.0/reference/cli/influxd) for information about
available flags and options._
## Set up InfluxDB through the UI
1. With `influxd` running, visit [localhost:9999](http://localhost:9999).
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.
You are ready to [collect data](#).
## Set up InfluxDB through the influx CLI
Begin the InfluxDB setup process via the `influx` CLI by running:
## Through the influx CLI
```bash ```bash
influx setup 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**.
6. Enter a **retention period** (in hours) for your primary bucket.
Enter nothing for an infinite retention period.
7. Confirm the details for your primary user, organization, and bucket.
InfluxDB is now initialized with a primary user, organization, and bucket.
You are ready to [collect data](#).

View File

@ -1,6 +1,6 @@
--- ---
title: influx CLI title: influx - InfluxDB command line interface
seotitle: "'influx' command line client" seotitle: influx - InfluxDB command line interface
description: > description: >
The influx CLI includes commands to manage many aspects of InfluxDB, The influx CLI includes commands to manage many aspects of InfluxDB,
including buckets, organizations, users, tasks, etc. including buckets, organizations, users, tasks, etc.
@ -11,7 +11,7 @@ menu:
weight: 1 weight: 1
--- ---
The `influx` CLI includes commands to manage many aspects of InfluxDB, The `influx` command line interface (CLI) includes commands to manage many aspects of InfluxDB,
including buckets, organizations, users, tasks, etc. including buckets, organizations, users, tasks, etc.
## Usage ## Usage

View File

@ -1,7 +1,7 @@
--- ---
title: influxd - InfluxDB daemon title: influxd - InfluxDB daemon
seotitle: influxd - InfluxDB daemon seotitle: influxd - InfluxDB daemon
description: placeholder description: The influxd daemon starts and runs all the processes necessary for InfluxDB to function.
menu: menu:
v2_0_ref: v2_0_ref:
name: influxd name: influxd
@ -9,6 +9,8 @@ menu:
weight: 2 weight: 2
--- ---
The `influxd` daemon starts and runs all the processes necessary for InfluxDB to function.
## Usage ## Usage
``` ```
influxd [flags] influxd [flags]