From 56bdda83aa36752016d7320b6f3372989fd692ca Mon Sep 17 00:00:00 2001 From: Jamie Strandboge Date: Thu, 18 Dec 2025 17:05:34 -0600 Subject: [PATCH] fix: add a few missing DEB/RPM instructions for license activation; shell source is for quick install (#6652) * fix: add a few missing DEB/RPM instructions for license activation * fix: sourcing shell config only needed with quick installs * chore: address review feedback from Jason --- content/influxdb3/enterprise/admin/license.md | 25 ++++++++++--------- content/shared/influxdb3/install.md | 2 +- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/content/influxdb3/enterprise/admin/license.md b/content/influxdb3/enterprise/admin/license.md index 32ac499e0..bcf4d2882 100644 --- a/content/influxdb3/enterprise/admin/license.md +++ b/content/influxdb3/enterprise/admin/license.md @@ -117,9 +117,9 @@ The license file is a JWT file that contains the license information. 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 -- Set the [`license-email`](/influxdb3/enterprise/reference/config-options/#license-email) option in the `/etc/influxdb3/influxdb3-enterprise.conf` file (DEB/RPM installs) +- **CLI option:** Use the [`--license-email`](/influxdb3/enterprise/reference/cli/influxdb3/serve/) option with the `influxdb3 serve` command +- **Environment variable:** Set the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable +- **TOML config (DEB/RPM-only):** Set the [`license-email`](/influxdb3/enterprise/reference/config-options/#license-email) option in the [`/etc/influxdb3/influxdb3-enterprise.conf` file](/influxdb3/enterprise/install/#toml-configuration-linux) for a DEB or RPM install If the server finds a valid license file in your object store, it ignores the license email option. @@ -133,8 +133,9 @@ address with the license server. To use your existing license--for example, if you deleted your license file--provide your email address using one of the following methods: -- Use the [`--license-email`](/influxdb3/enterprise/reference/cli/influxdb3/serve/) option with the `influxdb3 serve` command -- Set the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable +- **CLI option:** Use the [`--license-email`](/influxdb3/enterprise/reference/cli/influxdb3/serve/) option with the `influxdb3 serve` command +- **Environment variable:** Set the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable +- **TOML config (DEB/RPM-only):** Set the [`license-email`](/influxdb3/enterprise/reference/config-options/#license-email) option in the [`/etc/influxdb3/influxdb3-enterprise.conf` file](/influxdb3/enterprise/install/#toml-configuration-linux) for a DEB or RPM install InfluxDB validates your email address with the license server and uses your existing license if it's still valid. @@ -163,16 +164,16 @@ existing license if it's still valid. 2. When starting the {{< product-name >}} server, provide the license file path using one of the following methods: - - - Use the [`--license-file`](/influxdb3/enterprise/reference/config-options/#license-file) - option with the `influxdb3 serve` command - - Set the `INFLUXDB3_ENTERPRISE_LICENSE_FILE` environment variable. + + - **CLI option:** Use the [`--license-file`](/influxdb3/enterprise/reference/config-options/#license-file) option with the `influxdb3 serve` command + - **Environment variable:** Set the `INFLUXDB3_ENTERPRISE_LICENSE_FILE` environment variable. + - **TOML config (DEB/RPM-only):** Set the [`license-file`](/influxdb3/enterprise/reference/config-options/#license-file) option in the [`/etc/influxdb3/influxdb3-enterprise.conf` file](/influxdb3/enterprise/install/#toml-configuration-linux) for a DEB or RPM install ### License detection {{% product-name %}} checks for a license file in the following order: -1. The license file path provided with the [`--license-file`](/influxdb3/enterprise/reference/config-options/#license-file) option +1. The license file path provided with the [`--license-file`](/influxdb3/enterprise/reference/config-options/#license-file) command line option or [`license-file`](/influxdb3/enterprise/reference/config-options/#license-file) TOML option (DEB/RPM installs) 2. The license file path provided with the `INFLUXDB3_ENTERPRISE_LICENSE_FILE` environment variable 3. The default license path: @@ -185,10 +186,10 @@ existing license if it's still valid. ``` ///trial_or_home_license ``` -5. The license email provided with the [`--license-email`](/influxdb3/enterprise/reference/config-options/#license-email) option +5. The license email provided with the [`--license-email`](/influxdb3/enterprise/reference/config-options/#license-email) command line option or [`license-email`](/influxdb3/enterprise/reference/config-options/#license-email) TOML option (DEB/RPM installs) 6. The license email provided with the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable -7. If no license is found, the server won't start +7. If no license is found, the server won't start ### Start the server with your license email diff --git a/content/shared/influxdb3/install.md b/content/shared/influxdb3/install.md index bdb7b25b5..1d7c38eba 100644 --- a/content/shared/influxdb3/install.md +++ b/content/shared/influxdb3/install.md @@ -261,7 +261,7 @@ that it installed successfully: influxdb3 --version ``` -If your system doesn't locate `influxdb3`, then `source` the configuration file (for example, .bashrc, .zshrc) for your shell--for example: +If your system can't locate `influxdb3` following a [quick install](#quick-install-for-linux-and-macos), `source` the configuration file (for example, `.bashrc`, `.zshrc`) for your shell--for example: ```zsh