Skip to content

Commit

Permalink
docs(i): Fix incorrect flag and env variable (sourcenetwork#3034)
Browse files Browse the repository at this point in the history
## Relevant issue(s)

Resolves sourcenetwork#3033 

## Description

The flag and environment variable was kept unchanged from an initial
commit in the non-interactive keyring PR. This fixes the mistake.
  • Loading branch information
fredcarle authored Sep 19, 2024
1 parent 3d787f3 commit e798675
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The following keys are loaded from the keyring on start:
- `peer-key` Ed25519 private key (required)
- `encryption-key` AES-128, AES-192, or AES-256 key (optional)

A secret to unlock the keyring is required on start and must be provided via the `DEFRADB_KEYRING_SECRET` environment variable. If a `.env` file is available in the working directory, the secret can be stored there or via a file at a path defined by the `--keyring-secret-file` flag.
A secret to unlock the keyring is required on start and must be provided via the `DEFRA_KEYRING_SECRET` environment variable. If a `.env` file is available in the working directory, the secret can be stored there or via a file at a path defined by the `--secret-file` flag.

The keys will be randomly generated on the inital start of the node if they are not found.

Expand Down
2 changes: 1 addition & 1 deletion cli/keyring_export.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Prints the hexadecimal representation of a private key.
The DEFRA_KEYRING_SECRET environment variable must be set to unlock the keyring.
This can also be done with a .env file in the working directory or at a path
defined with the --keyring-secret-file flag.
defined with the --secret-file flag.
Example:
defradb keyring export encryption-key`,
Expand Down
2 changes: 1 addition & 1 deletion cli/keyring_generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ By default peer and encryption keys will be generated.
The DEFRA_KEYRING_SECRET environment variable must be set to unlock the keyring.
This can also be done with a .env file in the working directory or at a path
defined with the --keyring-secret-file flag.
defined with the --secret-file flag.
WARNING: This will overwrite existing keys in the keyring.
Expand Down
2 changes: 1 addition & 1 deletion cli/keyring_import.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Store an externally generated key in the keyring.
The DEFRA_KEYRING_SECRET environment variable must be set to unlock the keyring.
This can also be done with a .env file in the working directory or at a path
defined with the --keyring-secret-file flag.
defined with the --secret-file flag.
Example:
defradb keyring import encryption-key 0000000000000000`,
Expand Down
2 changes: 1 addition & 1 deletion docs/website/references/cli/defradb_keyring_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Prints the hexadecimal representation of a private key.

The DEFRA_KEYRING_SECRET environment variable must be set to unlock the keyring.
This can also be done with a .env file in the working directory or at a path
defined with the --keyring-secret-file flag.
defined with the --secret-file flag.

Example:
defradb keyring export encryption-key
Expand Down
2 changes: 1 addition & 1 deletion docs/website/references/cli/defradb_keyring_generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ By default peer and encryption keys will be generated.

The DEFRA_KEYRING_SECRET environment variable must be set to unlock the keyring.
This can also be done with a .env file in the working directory or at a path
defined with the --keyring-secret-file flag.
defined with the --secret-file flag.

WARNING: This will overwrite existing keys in the keyring.

Expand Down
2 changes: 1 addition & 1 deletion docs/website/references/cli/defradb_keyring_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Store an externally generated key in the keyring.

The DEFRA_KEYRING_SECRET environment variable must be set to unlock the keyring.
This can also be done with a .env file in the working directory or at a path
defined with the --keyring-secret-file flag.
defined with the --secret-file flag.

Example:
defradb keyring import encryption-key 0000000000000000
Expand Down

0 comments on commit e798675

Please sign in to comment.