Skip to content

Commit a85f563

Browse files
gwossumsandersonjstirnaman
authored
Document use-hashed-tokens configuration option (#6585)
* Document use-hashed-tokens configuration option Added documentation for the use-hashed-tokens option, including its benefits, default value, and configuration methods. * Update documentation for use-hashed-tokens option Clarify default behavior for hashed API tokens in version 2.8 and future versions. --------- Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
1 parent 271834c commit a85f563

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

content/influxdb/v2/reference/config-options.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ To configure InfluxDB, use the following configuration options when starting the
194194
- [tls-strict-ciphers](#tls-strict-ciphers)
195195
- [tracing-type](#tracing-type)
196196
- [ui-disabled](#ui-disabled)
197+
- [use-hashed-tokens](#use-hashed-tokens)
197198
- [vault-addr](#vault-addr)
198199
- [vault-cacert](#vault-cacert)
199200
- [vault-capath](#vault-capath)
@@ -3470,6 +3471,61 @@ ui-disabled = true
34703471

34713472
---
34723473

3474+
### use-hashed-tokens
3475+
Enable storing hashed API tokens on disk. Hashed tokens are disabled by default in version 2.8. Hashed tokens will be enabled by default in a future version.
3476+
3477+
Storing hashed tokens increases security by storing API tokens as hashes on disk. When enabled, all unhashed tokens are converted to hashed tokens on every startup leaving no unhashed tokens on disk. Newly created tokens are also stored as hashes. Lost tokens must be replaced when token hashing is enabled because the hashing prevents them from being recovered.
3478+
3479+
If token hashing is disabled after being enabled, any hashed tokens on disk remain as hashed tokens. Newly created tokens are stored unhashed when token hashing is disabled. Hashed tokens on disk remain valid and useable even with token hashing disabled.
3480+
3481+
Hashed token support is available in versions 2.8.0 and newer. Downgrading to older versions is not recommended after enabling hashed tokens because the downgrade process deletes all stored hashed tokens. All hashed tokens must be replaced on a downgrade after hashed tokens are enabled.
3482+
3483+
**Default:** `false`
3484+
3485+
| influxd flag | Environment variable | Configuration key |
3486+
| :-------------- | :-------------------- | :---------------- |
3487+
| `--use-hashed-tokens` | `INFLUXD_USE_HASHED_TOKENS` | `use-hashed-tokens` |
3488+
3489+
###### influxd flag
3490+
<!--pytest.mark.skip-->
3491+
3492+
```sh
3493+
influxd --use-hashed-tokens
3494+
```
3495+
3496+
###### Environment variable
3497+
```sh
3498+
export INFLUXD_USE_HASHED_TOKENS=true
3499+
```
3500+
3501+
###### Configuration file
3502+
{{< code-tabs-wrapper >}}
3503+
{{% code-tabs %}}
3504+
[YAML](#)
3505+
[TOML](#)
3506+
[JSON](#)
3507+
{{% /code-tabs %}}
3508+
{{% code-tab-content %}}
3509+
```yml
3510+
use-hashed-tokens: true
3511+
```
3512+
{{% /code-tab-content %}}
3513+
{{% code-tab-content %}}
3514+
```toml
3515+
use-hashed-tokens = true
3516+
```
3517+
{{% /code-tab-content %}}
3518+
{{% code-tab-content %}}
3519+
```json
3520+
{
3521+
"use-hashed-tokens": true
3522+
}
3523+
```
3524+
{{% /code-tab-content %}}
3525+
{{< /code-tabs-wrapper >}}
3526+
3527+
---
3528+
34733529
### vault-addr
34743530
Specifies the address of the Vault server expressed as a URL and port.
34753531
For example: `https://127.0.0.1:8200/`.

0 commit comments

Comments
 (0)