Skip to content

cli: correct keyring new and --keyring-path help text #4729

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

Open
SAY-5 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

cli: correct keyring new and --keyring-path help text #4729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 8 additions & 4 deletions cli/keyring_new.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,15 @@ func MakeKeyringNewCommand(ctx context.Context) *cobra.Command {
Randomly generate and store private keys in the keyring.
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 --secret-file flag.
The DEFRA_KEYRING_SECRET environment variable is used to unlock an existing
keyring. When no value is provided on a first run the keyring is initialised
with "secret" as its password, which should be rotated before putting the
node into production. The value can also be supplied through a .env file in
the working directory or at a path defined with the --secret-file flag.

WARNING: This will overwrite existing keys in the keyring.`,
Existing keys are preserved unless --force is passed; running the command
again without --force when a key already exists returns an error rather
than overwriting.`,
RunE: func(cmd *cobra.Command, args []string) error {
k, err := openKeyring(cmd)
if err != nil {
Expand Down
4 changes: 3 additions & 1 deletion cli/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ Start a DefraDB node, interact with a local or remote node, and much more.
cmd.PersistentFlags().String(
"keyring-path",
cfg.GetString(config.ConfigFlags["keyring-path"]),
"Path to store encrypted keys when using the file backend",
"Path to store encrypted keys when using the file backend. "+
"Relative paths are resolved against --rootdir, so the default "+
"\"keys\" resolves to <rootdir>/keys (usually ~/.defradb/keys).",
)
cmd.PersistentFlags().Bool(
"no-keyring",
Expand Down