From 7d6ae5118353e0ee0d410828203a5aeac07c7cff Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 17 Jun 2025 16:50:55 -0500 Subject: [PATCH 1/4] chore(enterprise3): Strongly recommend to provide the email address when using Docker, especially Docker Compose, in order for license generation to complete: - Install Enterprise - Admin license - If only one pagination button (prev or next), allow it to fill the width. - Combines core and enterprise install into a shared page. --- .../layouts/article/_pagination-btns.scss | 5 + compose.yaml | 25 ++ content/influxdb3/core/install.md | 200 +-------------- content/influxdb3/enterprise/admin/license.md | 79 +++++- content/influxdb3/enterprise/install.md | 201 +-------------- .../shared/influxdb3-get-started/_index.md | 2 +- content/shared/influxdb3/install.md | 239 ++++++++++++++++++ 7 files changed, 344 insertions(+), 407 deletions(-) create mode 100644 content/shared/influxdb3/install.md diff --git a/assets/styles/layouts/article/_pagination-btns.scss b/assets/styles/layouts/article/_pagination-btns.scss index 7f44860f7..c069bc8ae 100644 --- a/assets/styles/layouts/article/_pagination-btns.scss +++ b/assets/styles/layouts/article/_pagination-btns.scss @@ -34,5 +34,10 @@ vertical-align: middle; } } + + // Remove max-width when only one button is present + &:only-child { + max-width: none; + } } } diff --git a/compose.yaml b/compose.yaml index fe0293615..203f853c9 100644 --- a/compose.yaml +++ b/compose.yaml @@ -311,6 +311,31 @@ services: - --log-filter=debug - --object-store=file - --data-dir=/var/lib/influxdb3 + influxdb3-enterprise: + container_name: influxdb3-enterprise + image: influxdb:3-enterprise + ports: + - 8181:8181 + # Change the INFLUXDB3_LICENSE_EMAIL environment variable to your email address. You can also set it in a `.env` file in the same directory as this compose file. Docker Compose automatically loads the .env file. + # The license email option is only used the first time you run the container; you can't change the license email after the first run. + # The server stores the license in the data directory in the object store and the license is associated with the cluster ID and email. + command: + - influxdb3 + - serve + - --node-id=node0 + - --cluster-id=cluster0 + - --log-filter=debug + - --object-store=file + - --data-dir=/var/lib/influxdb3 + - --plugin-dir=/var/lib/influxdb3/plugins + - --license-email=${INFLUXDB3_LICENSE_EMAIL} + volumes: + - type: bind + source: docker/influxdb3/data + target: /var/lib/influxdb3 + - type: bind + source: docker/influxdb3/plugins + target: /var/lib/influxdb3-plugins telegraf-pytest: container_name: telegraf-pytest image: influxdata/docs-pytest diff --git a/content/influxdb3/core/install.md b/content/influxdb3/core/install.md index a423ff48c..1d21a6376 100644 --- a/content/influxdb3/core/install.md +++ b/content/influxdb3/core/install.md @@ -6,205 +6,9 @@ menu: name: Install InfluxDB 3 Core weight: 2 influxdb3/core/tags: [install] +source: /shared/influxdb3/install.md alt_links: v1: /influxdb/v1/introduction/install/ --- -- [System Requirements](#system-requirements) -- [Quick install](#quick-install) -- [Download {{% product-name %}} binaries](#download-influxdb-3-{{< product-key >}}-binaries) -- [Docker image](#docker-image) - -## System Requirements - -#### Operating system - -{{< product-name >}} runs on **Linux**, **macOS**, and **Windows**. - -#### Object storage - -A key feature of InfluxDB 3 is its use of object storage to store time series -data in Apache Parquet format. You can choose to store these files on your local -file system. Performance on your local filesystem will likely be better, but -object storage has the advantage of not running out of space and being accessible -by other systems over the network. {{< product-name >}} natively supports Amazon S3, -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 - -Use the InfluxDB 3 quick install script to install {{< product-name >}} on -**Linux** and **macOS**. - -> [!Important] -> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-{{< product-key >}}-binaries). - -1. Use the following command to download and install the appropriate - {{< product-name >}} package on your local machine: - - ```bash - curl -O https://www.influxdata.com/d/install_influxdb3.sh \ - && sh install_influxdb3.sh - ``` - -2. Verify that installation completed successfully: - - ```bash - influxdb3 --version - ``` - -> [!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 -``` -{{% /code-tab-content %}} -{{< /code-tabs-wrapper >}} - -## Download {{% product-name %}} binaries - -{{< tabs-wrapper >}} -{{% tabs %}} -[Linux](#) -[macOS](#) -[Windows](#) -{{% /tabs %}} -{{% tab-content %}} - - - -- [{{< product-name >}} • 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) - • - [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256) - - - -{{% /tab-content %}} -{{% tab-content %}} - - - -- [{{< product-name >}} • 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. - - - -{{% /tab-content %}} -{{% tab-content %}} - - - -- [{{< 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) - - - -{{% /tab-content %}} -{{< /tabs-wrapper >}} - -## Docker image - -Use the `influxdb3-{{< 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 - - -```bash -docker pull influxdb:3-{{< product-key >}} -``` - -Docker automatically pulls the appropriate image for your system architecture. - -To specify the system architecture, use platform-specific tags--for example: - -```bash -# For x86_64/AMD64 -docker pull \ ---platform linux/amd64 \ -influxdb:3-{{< product-key >}} -``` - -```bash -# For ARM64 -docker pull \ ---platform linux/arm64 \ -influxdb:3-{{< product-key >}} -``` - -> [!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 - -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 - ``` - -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--for example: -> -> -> ```bash -> ps -ef | grep influxdb3 -> kill -9 -> ``` -> -> Currently, a bug prevents using {{< keybind all="Ctrl+c" >}} in the terminal to stop an InfluxDB 3 container. - -{{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Core" >}} + \ No newline at end of file diff --git a/content/influxdb3/enterprise/admin/license.md b/content/influxdb3/enterprise/admin/license.md index cb1f1bf37..5c8c59918 100644 --- a/content/influxdb3/enterprise/admin/license.md +++ b/content/influxdb3/enterprise/admin/license.md @@ -73,22 +73,49 @@ physical and virtual CPU cores. ## Activate a license -Each {{< product-name >}} license must be activated, but the process of activating -the license depends on the license type: +Each {{< product-name >}} license must be activated when you start the server, +but the process of activating the license depends on the license type: - [Activate a trial or at-home license](#activate-a-trial-or-at-home-license) - [Activate a commercial license](#activate-a-commercial-license) ### Activate a trial or at-home license -When starting the {{< product-name >}} server, it asks what type of -license you would like to use. -Select `trial` or `home` and provide your -email address. -The server auto-generates and stores your license. +1. Use the [`influxdb3 serve` command](/influxdb3/enterprise/reference/cli/influxdb3/serve/) to start the server. + If the server doesn't find a license file or email address, the server prompts you + to enter your email address. + If you're [activating a trial or home license with Docker](#activate-a-trial-or-home-license-with-docker), include options to [skip the email prompt](#skip-the-email-prompt). +2. The server prompts you to select a license type. Select `trial` or `home`. +3. In the verification email from {{% product-name %}}, + click the button to verify your email address. +After you verify your email address, {{% product-name %}} auto-generates a +license (associated with your cluster and email address) and stores the license +file in your object store. The license file is a JWT file that contains the license information. +> [!Important] +> #### Activate a trial or home license with Docker +> +> If you're starting a new {{% product-name %}} server in a Docker container, you must +> use one of the methods to [skip the email prompt](#skip-the-email-prompt). +> This ensures that the container can generate the license file after you +> verify your email address. +> See the [Docker Compose example](?t=Docker+compose#activate-a-trial-or-home-license-with-docker). + +#### Skip the email prompt + +To skip the email prompt when starting the server, you can provide your email +address using one of the following methods: + +- Use the [`--license-email`](/influxdb3/enterprise/reference/config-options/#license-email) option with the `influxdb3 serve` command +- Set the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable + +If the server finds a valid license file in your object store, it ignores the +the license email option. + +See examples to [start the server with your license email](#start-the-server-with-your-license-email). + #### Use an existing trial or at-home license When you activate a trial or at-home license, InfluxDB registers your email @@ -153,12 +180,13 @@ existing license if it's still valid. environment variable 7. If no license is found, the server won't start -#### Example: Start the {{% product-name %}} server with your license email: +### Start the server with your license email {{< code-tabs-wrapper >}} {{% code-tabs %}} [influxdb3 options](#) [Environment variables](#) +[Docker compose](#example-activate-trial-or-home-with-compose) {{% /code-tabs %}} {{% code-tab-content %}} @@ -185,9 +213,42 @@ influxdb3 serve \ ``` {{% /code-tab-content %}} +{{% code-tab-content %}} + +```yaml +# compose.yaml +name: data-crunching-stack +services: + influxdb3-enterprise: + container_name: influxdb3-enterprise + image: influxdb:3-enterprise + ports: + - 8181:8181 + # In the following command, replace INFLUXDB3_LICENSE_EMAIL with your email address. + # Alternatively, pass the `INFLUXDB3_LICENSE_EMAIL` environment variable or + # store the email address in a compose CLI .env file. + command: + - influxdb3 + - serve + - --node-id=node0 + - --cluster-id=cluster0 + - --object-store=file + - --data-dir=/var/lib/influxdb3 + - --plugin-dir=/var/lib/influxdb3/plugins + - --license-email=INFLUXDB3_LICENSE_EMAIL + volumes: + - type: bind + source: ~/.influxdb3/data + target: /var/lib/influxdb3 + - type: bind + source: ~/.influxdb3/plugins + target: /var/lib/influxdb3/plugins +``` + +{{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -#### Example: Start the {{% product-name %}} server with your license file: +### Start the server with your license file {{< code-tabs-wrapper >}} {{% code-tabs %}} diff --git a/content/influxdb3/enterprise/install.md b/content/influxdb3/enterprise/install.md index 3893d08d1..c153533c9 100644 --- a/content/influxdb3/enterprise/install.md +++ b/content/influxdb3/enterprise/install.md @@ -6,206 +6,9 @@ menu: name: Install InfluxDB 3 Enterprise weight: 2 influxdb3/enterprise/tags: [install] +source: /shared/influxdb3/install.md alt_links: v1: /influxdb/v1/introduction/install/ --- -- [System Requirements](#system-requirements) -- [Quick install](#quick-install) -- [Download {{% product-name %}} binaries](#download-influxdb-3-{{< product-key >}}-binaries) -- [Docker image](#docker-image) - -## System Requirements - -#### Operating system - -{{< product-name >}} runs on **Linux**, **macOS**, and **Windows**. - -#### Object storage - -A key feature of InfluxDB 3 is its use of object storage to store time series -data in Apache Parquet format. You can choose to store these files on your local -file system. Performance on your local filesystem will likely be better, but -object storage has the advantage of not running out of space and being accessible -by other systems over the network. {{< product-name >}} natively supports Amazon S3, -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 - -Use the InfluxDB 3 quick install script to install {{< product-name >}} on -**Linux** and **macOS**. - -> [!Important] -> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-{{< product-key >}}-binaries). - -1. Use the following command to download and install the appropriate - {{< product-name >}} package on your local machine: - - ```bash - curl -O https://www.influxdata.com/d/install_influxdb3.sh \ - && sh install_influxdb3.sh enterprise - ``` - -2. Verify that installation completed successfully: - - ```bash - influxdb3 --version - ``` - -> [!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 -``` -{{% /code-tab-content %}} -{{< /code-tabs-wrapper >}} - -## Download {{% product-name %}} binaries - -{{< tabs-wrapper >}} -{{% tabs %}} -[Linux](#) -[macOS](#) -[Windows](#) -{{% /tabs %}} -{{% tab-content %}} - - - -- [{{< product-name >}} • 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) - • - [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256) - - - -{{% /tab-content %}} -{{% tab-content %}} - - - -- [{{< product-name >}} • 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. - - - -{{% /tab-content %}} -{{% tab-content %}} - - - -- [{{< 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) - - - -{{% /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 - - -```bash -docker pull influxdb:3-{{< product-key >}} -``` - -Docker automatically pulls the appropriate image for your system architecture. - -To specify the system architecture, use platform-specific tags--for example: - -```bash -# For x86_64/AMD64 -docker pull \ ---platform linux/amd64 \ -influxdb:3-{{< product-key >}} -``` - -```bash -# For ARM64 -docker pull \ ---platform linux/arm64 \ -influxdb:3-{{< product-key >}} -``` - -> [!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 - -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: - - 9999:9999 - command: - - influxdb3 - - serve - - --node-id=node0 - - --cluster-id=cluster0 - - --object-store=file - - --data-dir=/var/lib/influxdb3 - ``` - -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--for example: -> -> -> ```bash -> ps -ef | grep influxdb3 -> kill -9 -> ``` -> -> Currently, a bug prevents using {{< keybind all="Ctrl+c" >}} in the terminal to stop an InfluxDB 3 container. - -{{< page-nav next="/influxdb3/enterprise/get-started/" nextText="Get started with InfluxDB 3 Enterprise" >}} + diff --git a/content/shared/influxdb3-get-started/_index.md b/content/shared/influxdb3-get-started/_index.md index b33698ea3..f53da9c7d 100644 --- a/content/shared/influxdb3-get-started/_index.md +++ b/content/shared/influxdb3-get-started/_index.md @@ -383,7 +383,7 @@ InfluxDB 3 Enterprise licenses authorize the use of the InfluxDB 3 Enterprise so - **At-Home**: For at-home hobbyist use with limited access to InfluxDB 3 Enterprise capabilities. - **Commercial**: Commercial license with full access to InfluxDB 3 Enterprise capabilities. -You can learn more on managing your InfluxDB 3 Enterprise license on the [Manage your license](https://docs.influxdata.com/influxdb3/enterprise/admin/license/) page. +For more information, see how to [Manage your license](/influxdb3/enterprise/admin/license/). {{% /show-in %}} ### Authentication and authorization diff --git a/content/shared/influxdb3/install.md b/content/shared/influxdb3/install.md new file mode 100644 index 000000000..a833376d6 --- /dev/null +++ b/content/shared/influxdb3/install.md @@ -0,0 +1,239 @@ + +- [System Requirements](#system-requirements) +- [Quick install](#quick-install) +- [Download {{% product-name %}} binaries](#download-influxdb-3-{{< product-key >}}-binaries) +- [Docker image](#docker-image) + +## System Requirements + +#### Operating system + +{{< product-name >}} runs on **Linux**, **macOS**, and **Windows**. + +#### Object storage + +A key feature of InfluxDB 3 is its use of object storage to store time series +data in Apache Parquet format. You can choose to store these files on your local +file system. Performance on your local filesystem will likely be better, but +object storage has the advantage of not running out of space and being accessible +by other systems over the network. {{< product-name >}} natively supports Amazon S3, +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 + +Use the InfluxDB 3 quick install script to install {{< product-name >}} on +**Linux** and **macOS**. + +> [!Important] +> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-{{< product-key >}}-binaries). + +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 %}} + +2. Verify that installation completed successfully: + + ```bash + influxdb3 --version + ``` + +> [!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 +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Download {{% product-name %}} binaries + +{{< tabs-wrapper >}} +{{% tabs %}} +[Linux](#) +[macOS](#) +[Windows](#) +{{% /tabs %}} +{{% tab-content %}} + + + +- [{{< product-name >}} • 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) + • + [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256) + + + +{{% /tab-content %}} +{{% tab-content %}} + + + +- [{{< product-name >}} • 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. + + + +{{% /tab-content %}} +{{% tab-content %}} + + + +- [{{< 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) + + + +{{% /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 + + +```bash +docker pull influxdb:3-{{< product-key >}} +``` + +Docker automatically pulls the appropriate image for your system architecture. + +To specify the system architecture, use platform-specific tags--for example: + +```bash +# For x86_64/AMD64 +docker pull \ +--platform linux/amd64 \ +influxdb:3-{{< product-key >}} +``` + +```bash +# For ARM64 +docker pull \ +--platform linux/arm64 \ +influxdb:3-{{< product-key >}} +``` + +> [!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 + +{{% 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. + +{{% show-in "enterprise" %}} +{{< page-nav next="/influxdb3/enterprise/get-started/" nextText="Get started with InfluxDB 3 Enterprise" >}} +{{% /show-in %}} +{{% show-in "core" %}} +{{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Core" >}} +{{% /show-in %}} \ No newline at end of file From 9e956dd00ea89010e73502127113e5364d2a403f Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 17 Jun 2025 16:54:44 -0500 Subject: [PATCH 2/4] fix(lefthook): glob syntax --- lefthook.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/lefthook.yml b/lefthook.yml index f405bf84a..e0deb6c70 100644 --- a/lefthook.yml +++ b/lefthook.yml @@ -85,7 +85,7 @@ pre-push: e2e-links: tags: test,links - glob: 'content/**/*.{md,html}' + glob: 'content/*.{md,html}' run: | echo "Running link checker for: {push_files}" yarn test:links {push_files} @@ -104,7 +104,7 @@ pre-push: run: yarn build:pytest:image # Test code blocks in markdown files cloud-pytest: - glob: content/influxdb/cloud/**/*.md + glob: content/influxdb/cloud/*.md tags: test,codeblocks,v2 env: SERVICE: cloud-pytest @@ -112,35 +112,35 @@ pre-push: cloud-dedicated-pytest: tags: test,codeblocks,v3 - glob: content/influxdb/cloud-dedicated/**/*.md + glob: content/influxdb/cloud-dedicated/*.md run: | yarn test:codeblocks:cloud-dedicated '{push_files}' && ./test/scripts/monitor-tests.sh stop cloud-dedicated-pytest cloud-serverless-pytest: tags: test,codeblocks,v3 - glob: content/influxdb/cloud-serverless/**/*.md + glob: content/influxdb/cloud-serverless/*.md env: SERVICE: cloud-serverless-pytest run: yarn test:codeblocks:cloud-serverless '{push_files}' clustered-pytest: tags: test,codeblocks,v3 - glob: content/influxdb/clustered/**/*.md + glob: content/influxdb/clustered/*.md run: | yarn test:codeblocks:clustered '{push_files}' && ./test/scripts/monitor-tests.sh stop clustered-pytest telegraf-pytest: tags: test,codeblocks - glob: content/telegraf/**/*.md + glob: content/telegraf/*.md env: SERVICE: telegraf-pytest run: yarn test:codeblocks:telegraf '{push_files}' v2-pytest: tags: test,codeblocks,v2 - glob: content/influxdb/v2/**/*.md + glob: content/influxdb/v2/*.md env: SERVICE: v2-pytest run: yarn test:codeblocks:v2 '{push_files}' \ No newline at end of file From d31a5a01393a7e88754e8a130414b4943f0c0623 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 17 Jun 2025 17:10:37 -0500 Subject: [PATCH 3/4] chore(vale): Upgrade vale, includes an updated brace-expansion with the vuln. patch --- yarn.lock | 42 +++++++++++++++++++++++++++++++----------- 1 file changed, 31 insertions(+), 11 deletions(-) diff --git a/yarn.lock b/yarn.lock index 5ef9f4c34..8f1613b2f 100644 --- a/yarn.lock +++ b/yarn.lock @@ -685,9 +685,9 @@ eslint-visitor-keys "^4.2.0" "@vvago/vale@^3.4.2": - version "3.9.6" - resolved "https://registry.yarnpkg.com/@vvago/vale/-/vale-3.9.6.tgz#5d21b9fa3d940c40853e7c47968ee70042f8bbef" - integrity sha512-KD48GmGT5dgFWz14bJb154NVRzjiRbnZk8n+Pk824r2Cn78vzLxzB9mGvn0OcOTZXC3IhqyUUo9vZo/V9SGfTw== + version "3.12.0" + resolved "https://registry.yarnpkg.com/@vvago/vale/-/vale-3.12.0.tgz#3b68fa5670d8d24a3aaa9b4709f66ebd5a7c85aa" + integrity sha512-9VxKDaJT0oyxJh+qN+tW2e78M+1xGMkXqbbZ2XlAvyhOrjA3OSOCaZQjRu6+c9lv/h1OQRNT50XIuhngrVoSew== dependencies: axios "^1.4.0" rimraf "^5.0.0" @@ -933,7 +933,16 @@ axe-core@^4.10.0: resolved "https://registry.yarnpkg.com/axe-core/-/axe-core-4.10.3.tgz#04145965ac7894faddbac30861e5d8f11bfd14fc" integrity sha512-Xm7bpRXnDSX2YE2YFfBk2FnF0ep6tmG7xPh8iHee8MIcrgq762Nkce856dYtJYLkuIoYZvGfTs/PbZhideTcEg== -axios@^1.4.0, axios@^1.7.4: +axios@^1.4.0: + version "1.10.0" + resolved "https://registry.yarnpkg.com/axios/-/axios-1.10.0.tgz#af320aee8632eaf2a400b6a1979fa75856f38d54" + integrity sha512-/1xYAC4MP/HEG+3duIhFr4ZQXR4sQXOIe+o6sdqzeykGLx6Upp/1p8MHqhINOvGeP7xyNHe7tsiJByc4SSVUxw== + dependencies: + follow-redirects "^1.15.6" + form-data "^4.0.0" + proxy-from-env "^1.1.0" + +axios@^1.7.4: version "1.8.3" resolved "https://registry.yarnpkg.com/axios/-/axios-1.8.3.tgz#9ebccd71c98651d547162a018a1a95a4b4ed4de8" integrity sha512-iP4DebzoNlP/YN2dpwCgb8zoCmhtkajzS48JvwmkSkXvPI3DHc7m+XYL5tGnSlJtR6nImXZmdCuN5aP8dh1d8A== @@ -1006,17 +1015,17 @@ bluebird@~3.4.1: integrity sha512-iD3898SR7sWVRHbiQv+sHUtHnMvC1o3nW5rAcqnq3uOn07DSAppZYUkIGslDz6gXC7HfunPe7YVBgoEJASPcHA== brace-expansion@^1.1.7: - version "1.1.11" - resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd" - integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA== + version "1.1.12" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.12.tgz#ab9b454466e5a8cc3a187beaad580412a9c5b843" + integrity sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg== dependencies: balanced-match "^1.0.0" concat-map "0.0.1" brace-expansion@^2.0.1: - version "2.0.1" - resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.1.tgz#1edc459e0f0c548486ecf9fc99f2221364b9a0ae" - integrity sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA== + version "2.0.2" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.2.tgz#54fc53237a613d854c7bd37463aad17df87214e7" + integrity sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ== dependencies: balanced-match "^1.0.0" @@ -2523,7 +2532,18 @@ form-data-encoder@^2.1.2: resolved "https://registry.yarnpkg.com/form-data-encoder/-/form-data-encoder-2.1.4.tgz#261ea35d2a70d48d30ec7a9603130fa5515e9cd5" integrity sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw== -form-data@^4.0.0, form-data@~4.0.0: +form-data@^4.0.0: + version "4.0.3" + resolved "https://registry.yarnpkg.com/form-data/-/form-data-4.0.3.tgz#608b1b3f3e28be0fccf5901fc85fb3641e5cf0ae" + integrity sha512-qsITQPfmvMOSAdeyZ+12I1c+CKSstAFAwu+97zrnWAbIr5u8wfsExUzCesVLC8NgHuRUqNN4Zy6UPWUTRGslcA== + dependencies: + asynckit "^0.4.0" + combined-stream "^1.0.8" + es-set-tostringtag "^2.1.0" + hasown "^2.0.2" + mime-types "^2.1.12" + +form-data@~4.0.0: version "4.0.2" resolved "https://registry.yarnpkg.com/form-data/-/form-data-4.0.2.tgz#35cabbdd30c3ce73deb2c42d3c8d3ed9ca51794c" integrity sha512-hGfm/slu0ZabnNt4oaRZ6uREyfCj6P4fT/n6A1rGV+Z0VdGXjfOhVUpkn6qVQONHGIFwmveGXyDs75+nr6FM8w== From b79c000f0e48a79cff0b5237cf7a4e083b695e3e Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Tue, 17 Jun 2025 15:23:08 -0700 Subject: [PATCH 4/4] Update content/influxdb3/enterprise/admin/license.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- content/influxdb3/enterprise/admin/license.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb3/enterprise/admin/license.md b/content/influxdb3/enterprise/admin/license.md index 5c8c59918..11d5b3471 100644 --- a/content/influxdb3/enterprise/admin/license.md +++ b/content/influxdb3/enterprise/admin/license.md @@ -112,7 +112,7 @@ address using one of the following methods: - Set the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable If the server finds a valid license file in your object store, it ignores the -the license email option. +license email option. See examples to [start the server with your license email](#start-the-server-with-your-license-email).