From 90c1cd7000ef0e4da70eadd505c40fdf4552a528 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 24 Jan 2019 13:45:22 -0700 Subject: [PATCH] adjusted instructions in the getting started doc --- content/v2.0/get-started.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/content/v2.0/get-started.md b/content/v2.0/get-started.md index e46cb70b3..afba18774 100644 --- a/content/v2.0/get-started.md +++ b/content/v2.0/get-started.md @@ -25,13 +25,25 @@ Download InfluxDB v2.0 alpha for macOS. InfluxDB v2.0 alpha (macOS) ### Place the executables in your $PATH -Unzip the download package and place the `influx` and `influxd` executables in your system `$PATH`. +Unpackage the downloaded archive and place the `influx` and `influxd` executables in your system `$PATH`. + +_**Note:** The following commands are examples. Adjust the file paths to your own needs._ ```sh -# Example -cp ~/Downloads/influxdb_2.0.0-alpha.1_darwin_amd64/{influx,influxd} /usr/local/bin/ +# Unpackage contents to the current working directory +gunzip -c ~/Downloads/influxdb_2.0.0-alpha.1_darwin_amd64.tar.gz | tar xopf - + +# Copy the influx and influxd binary to your $PATH +sudo cp influxdb_2.0.0-alpha.1_darwin_amd64/{influx,influxd} /usr/local/bin/ ``` +{{% 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 %}} + ### Networking ports By default, InfluxDB uses TCP port `9999` for client-server communication over InfluxDB’s HTTP API. @@ -71,13 +83,25 @@ Download InfluxDB v2.0 alpha package appropriate for your chipset. InfluxDB v2.0 alpha (arm) ### Place the executables in your $PATH -Unzip the download package and place the `influx` and `influxd` executables in your system `$PATH`. +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._ ```sh -# Example -cp /path/to/{influx,influxd} /usr/local/bin/ +# Unpackage contents to the current working directory +tar xvzf path/to/influxdb_2.0.0-alpha.1_linux_amd64.tar.gz + +# Copy the influx and influxd binary to your $PATH +sudo cp influxdb_2.0.0-alpha.1_linux_amd64/{influx,influxd} /usr/local/bin/ ``` +{{% 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 %}} + ### Networking ports By default, InfluxDB uses TCP port `9999` for client-server communication over InfluxDB’s HTTP API.