Skip to content

Add Windows environment variable instructions for INFLUXDB3_AUTH_TOKEN #6325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jstirnaman merged 11 commits into from
Dec 2, 2025
Merged

Add Windows environment variable instructions for INFLUXDB3_AUTH_TOKEN #6325

Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
429eea9
Initial plan
Copilot Aug 21, 2025
182f346
feat: add Windows environment variable instructions for INFLUXDB3_AUT…
Copilot Aug 21, 2025
0ea9ca8
refactor: update to new code-placeholders syntax
Copilot Aug 21, 2025
fda0246
Merge branch 'master' into copilot/fix-6290
jstirnaman Aug 21, 2025
8f00389
Merge branch 'master' into copilot/fix-6290
jstirnaman Oct 20, 2025
e561588
Merge branch 'master' into copilot/fix-6290
jstirnaman Nov 5, 2025
a95272f
Merge branch 'master' into copilot/fix-6290
jstirnaman Nov 5, 2025
23bce80
Separate env var and CLI option into distinct sections instead of nes…
Copilot Dec 2, 2025
f6fe430
Clarify that both auth methods are for CLI commands with parallel hea…
Copilot Dec 2, 2025
d89f33e
Merge branch 'master' into copilot/fix-6290
jstirnaman Dec 2, 2025
874eb22
fix(3ent/core): Set token env var in Windows, clean up structure
jstirnaman Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 30 additions & 12 deletions content/shared/influxdb3-get-started/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,12 +496,10 @@ influxdb3 create token --admin
{{% /code-tab-content %}}
{{% code-tab-content %}}

{{% code-placeholders "CONTAINER_NAME" %}}
```bash
```bash { placeholders="CONTAINER_NAME" }
# With Docker — in a new terminal:
docker exec -it CONTAINER_NAME influxdb3 create token --admin
```
{{% /code-placeholders %}}

Replace {{% code-placeholder-key %}}`CONTAINER_NAME`{{% /code-placeholder-key %}} with the name of your running Docker container.

Expand Down Expand Up @@ -537,34 +535,54 @@ In your command, replace {{% code-placeholder-key %}}`YOUR_AUTH_TOKEN`{{% /code-
Set the `INFLUXDB3_AUTH_TOKEN` environment variable to have the CLI use your
token automatically:

{{% code-placeholders "YOUR_AUTH_TOKEN" %}}
```bash
{{< tabs-wrapper >}}
Copy link
Contributor

@jstirnaman jstirnaman Nov 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tabs are now (incorrectly) nested. Separate into env var usage and CLI option usage.

Copy link
Contributor Author

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. The nested tabs structure has been removed. The documentation now uses two separate sequential sections instead:

  1. To have your token provided automatically, set the environment variable: (with OS-specific tabs)
  2. Include the --token option with CLI commands: (single example)

This matches the pattern used in the cloud-dedicated docs and provides better accessibility.

Commit: 23bce80

Updated documentation

Copy link
Contributor

@jstirnaman jstirnaman Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. The nested tabs structure has been removed. The documentation now uses two separate sequential sections instead:

  1. To have your token provided automatically, set the environment variable: (with OS-specific tabs)
  2. Include the --token option with CLI commands: (single example)

This matches the pattern used in the cloud-dedicated docs and provides better accessibility.

Commit: 23bce80

Updated documentation

@copilot Both apply to CLI commands; you can't use environment variables with anything else.

Copy link
Contributor Author

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the headings to clarify that both methods are for CLI commands. The headings are now parallel and clearer:

  • Set an environment variable (recommended)
  • Use the --token option

Both are presented as methods to provide your token for influxdb3 CLI commands, as stated in the introductory text.

Commit: f6fe430

Updated headings

{{% tabs %}}
[macOS and Linux](#)
[PowerShell](#)
[CMD](#)
{{% /tabs %}}
{{% tab-content %}}

```bash { placeholders="YOUR_AUTH_TOKEN" }
export INFLUXDB3_AUTH_TOKEN=YOUR_AUTH_TOKEN
```
{{% /code-placeholders %}}

{{% /tab-content %}}
{{% tab-content %}}

```powershell { placeholders="YOUR_AUTH_TOKEN" }
$env:INFLUXDB3_AUTH_TOKEN = "YOUR_AUTH_TOKEN"
```

{{% /tab-content %}}
{{% tab-content %}}

```cmd { placeholders="YOUR_AUTH_TOKEN" }
set INFLUXDB3_AUTH_TOKEN=YOUR_AUTH_TOKEN
# Make sure to include a space character at the end of this command.
```

{{% /tab-content %}}
{{< /tabs-wrapper >}}

{{% /tab-content %}}
{{% tab-content %}}

Include the `--token` option with CLI commands:

{{% code-placeholders "YOUR_AUTH_TOKEN" %}}
```bash
```bash { placeholders="YOUR_AUTH_TOKEN" }
influxdb3 show databases --token YOUR_AUTH_TOKEN
```
{{% /code-placeholders %}}

{{% /tab-content %}}
{{< /tabs-wrapper >}}

For HTTP API requests, include your token in the `Authorization` header--for example:

{{% code-placeholders "YOUR_AUTH_TOKEN" %}}
```bash
```bash { placeholders="YOUR_AUTH_TOKEN" }
curl "http://{{< influxdb/host >}}/api/v3/configure/database" \
--header "Authorization: Bearer YOUR_AUTH_TOKEN"
```
{{% /code-placeholders %}}

#### Learn more about tokens and permissions

Expand Down