diff --git a/content/shared/influxdb3/install.md b/content/shared/influxdb3/install.md index a833376d6..e910453dd 100644 --- a/content/shared/influxdb3/install.md +++ b/content/shared/influxdb3/install.md @@ -4,6 +4,12 @@ - [Download {{% product-name %}} binaries](#download-influxdb-3-{{< product-key >}}-binaries) - [Docker image](#docker-image) +{{% show-in "enterprise" %}} +> [!Note] +> For information about setting up a multi-node {{% product-name %}} cluster, +> see [Create a multi-node cluster](/influxdb3/enterprise/install/multi-server/). +{{% /show-in %}} + ## System Requirements #### Operating system @@ -21,119 +27,69 @@ Azure Blob Storage, and Google Cloud Storage. You can also use many local object storage implementations that provide an S3-compatible API, such as [Minio](https://min.io/). -## Quick install +## Install {{% product-name %}} -Use the InfluxDB 3 quick install script to install {{< product-name >}} on -**Linux** and **macOS**. +{{% product-name %}} runs on **Linux**, **macOS**, and **Windows**. -> [!Important] -> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-{{< product-key >}}-binaries). +Choose one of the following methods to install {{% product-name %}}: -1. Use the following command to download and install the appropriate - {{< product-name >}} package on your local machine: -{{% show-in "enterprise" %}} - - ```bash - curl -O https://www.influxdata.com/d/install_influxdb3.sh \ - && sh install_influxdb3.sh {{% product-key %}} - ``` -{{% /show-in %}} -{{% show-in "core" %}} - - ```bash - curl -O https://www.influxdata.com/d/install_influxdb3.sh \ - && sh install_influxdb3.sh - ``` -{{% /show-in %}} +- [Quick install for Linux and macOS](#quick-install-for-linux-and-macos) +- [Download and install the latest build artifacts](#download-and-install-the-latest-build-artifacts) +- [Pull the Docker image](#pull-the-docker-image) -2. Verify that installation completed successfully: +### Quick install for Linux and macOS - ```bash - influxdb3 --version - ``` +To install {{% product-name %}} on **Linux** or **macOS**, download and run the quick +installer script for {{% product-name %}}--for example, using [`curl`](https://curl.se/) +to download the script: -> [!Note] -> -> #### influxdb3 not found -> -> If your system can't locate your `influxdb3` binary, `source` your -> current shell configuration file (`.bashrc`, `.zshrc`, etc.). -> -> {{< code-tabs-wrapper >}} -{{% code-tabs %}} -[.bashrc](#) -[.zshrc](#) -{{% /code-tabs %}} -{{% code-tab-content %}} -```bash -source ~/.bashrc -``` -{{% /code-tab-content %}} -{{% code-tab-content %}} ```bash -source ~/.zshrc +curl -O https://www.influxdata.com/d/install_influxdb3.sh \ +&& sh install_influxdb3.sh {{% show-in "enterprise" %}}enterprise{{% /show-in %}} ``` -{{% /code-tab-content %}} -{{< /code-tabs-wrapper >}} -## Download {{% product-name %}} binaries +> [!Note] +> The quick installer script is updated with each {{% product-name %}} release, +> so it always installs the latest version. -{{< tabs-wrapper >}} -{{% tabs %}} -[Linux](#) -[macOS](#) -[Windows](#) -{{% /tabs %}} -{{% tab-content %}} +### Download and install the latest build artifacts - +You can also download and install [{{% product-name %}} build artifacts](/influxdb3/enterprise/install/#download-influxdb-3-enterprise-binaries) directly: -- [{{< product-name >}} • Linux (AMD64, x86_64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz) +{{< expand-wrapper >}} +{{% expand "Linux binaries" %}} + +- [Linux | AMD64 (x86_64) | GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz) • [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz.sha256) - -- [{{< product-name >}} • Linux (ARM64, AArch64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz) +- [Linux | ARM64 (AArch64) | GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz) • [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256) - +{{% /expand %}} +{{% expand "macOS binaries" %}} -{{% /tab-content %}} -{{% tab-content %}} - - - -- [{{< product-name >}} • macOS (Silicon, ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz) +- [macOS | Silicon (ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz) • [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz.sha256) > [!Note] > macOS Intel builds are coming soon. - +{{% /expand %}} +{{% expand "Windows binaries" %}} -{{% /tab-content %}} -{{% tab-content %}} +- [Windows (AMD64, x86_64) binary](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip) + • +[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256) - +{{% /expand %}} +{{< /expand-wrapper >}} -- [{{< product-name >}} • Windows (AMD64, x86_64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip) - • - [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256) +### Pull the Docker image - - -{{% /tab-content %}} -{{< /tabs-wrapper >}} - -## Docker image - -Use the `influxdb:3-{{< product-key >}}` Docker image to deploy {{< product-name >}} in a -Docker container. -The image is available for x86_64 (AMD64) and ARM64 architectures. - -### Use Docker CLI +Run the following command to pull the [`influxdb:3-{{< product-key >}}` image](https://hub.docker.com/_/influxdb/tags?tag=3-{{< product-key >}}&name=3-{{< product-key >}}), available for x86_64 (AMD64) and ARM64 architectures: ```bash @@ -142,6 +98,8 @@ docker pull influxdb:3-{{< product-key >}} Docker automatically pulls the appropriate image for your system architecture. +{{< expand-wrapper >}} +{{% expand "Pull for a specific system architecture" %}} To specify the system architecture, use platform-specific tags--for example: ```bash @@ -157,79 +115,31 @@ docker pull \ --platform linux/arm64 \ influxdb:3-{{< product-key >}} ``` +{{% /expand %}} +{{< /expand-wrapper >}} -> [!Note] -> The {{% product-name %}} Docker image exposes port `8181`, the `influxdb3` server default for HTTP connections. -> To map the exposed port to a different port when running a container, see the Docker guide for [Publishing and exposing ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/). -### Use Docker Compose +### Verify the installation + +After installing {{% product-name %}}, enter the following command to verify +that it installed successfully: + +```bash +influxdb3 --version +``` + +If your system doesn't locate `influxdb3`, then `source` the configuration file (for example, .bashrc, .zshrc) for your shell--for example: + + +```zsh +source ~/.zshrc +``` {{% show-in "enterprise" %}} -1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}. - To generate a trial or at-home license for {{% product-name %}} when using Docker, you must pass the `--license-email` option or the `INFLUXDB3_LICENSE_EMAIL` environment variable the first time you start the server--for example: - - ```yaml - # compose.yaml - services: - influxdb3-{{< product-key >}}: - container_name: influxdb3-{{< product-key >}} - image: influxdb:3-{{< product-key >}} - ports: - - 8181:8181 - command: - - influxdb3 - - serve - - --node-id=node0 - - --cluster-id=cluster0 - - --object-store=file - - --data-dir=/var/lib/influxdb3 - - --plugins-dir=/var/lib/influxdb3-plugins - - --license-email=${INFLUXDB3_LICENSE_EMAIL} - ``` -{{% /show-in %}} -{{% show-in "core" %}} -1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}--for example: - - ```yaml - # compose.yaml - services: - influxdb3-{{< product-key >}}: - container_name: influxdb3-{{< product-key >}} - image: influxdb:3-{{< product-key >}} - ports: - - 8181:8181 - command: - - influxdb3 - - serve - - --node-id=node0 - - --object-store=file - - --data-dir=/var/lib/influxdb3 - - --plugins-dir=/var/lib/influxdb3-plugins - ``` -{{% /show-in %}} - -2. Use the Docker Compose CLI to start the server. - - Optional: to make sure you have the latest version of the image before you - start the server, run `docker compose pull`. - - - ```bash - docker compose pull && docker compose run influxdb3-{{< product-key >}} - ``` - > [!Note] -> #### Stopping an InfluxDB 3 container -> -> To stop a running InfluxDB 3 container, find and terminate the process or container--for example: -> -> -> ```bash -> docker container ls --filter "name=influxdb3" -> docker kill -> ``` -> -> Currently, a bug prevents using {{< keybind all="Ctrl+c" >}} in the terminal to stop an InfluxDB 3 container. +> For information about setting up a multi-node {{% product-name %}} cluster, +> see [Create a multi-node cluster](/influxdb3/enterprise/install/multi-server/). +{{% /show-in %}} {{% show-in "enterprise" %}} {{< page-nav next="/influxdb3/enterprise/get-started/" nextText="Get started with InfluxDB 3 Enterprise" >}}