Skip to main content
Version: 1.0

defradb_keyring_new

defradb keyring new​

Create new private keys

Synopsis​

Create new private keys. Randomly generate and store private keys in the keyring. By default peer and encryption keys will be generated.

The DEFRA_KEYRING_SECRET environment variable is used 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. If it is not set and the command is run in an interactive terminal, you will be prompted to enter it.

WARNING: This will overwrite existing keys in the keyring.

defradb keyring new [flags]

Examples​

Create new keys:
defradb keyring new

with no encryption key:
defradb keyring new --no-encryption

with no peer key:
defradb keyring new --no-peer-key

with system keyring:
defradb keyring new --keyring-backend system

Options​

--force Overwrite existing keys
-h, --help help for new
--no-encryption Skip generating an encryption key. Encryption at rest will be disabled
--no-peer-key Skip generating a peer key.

Options inherited from parent commands​

--keyring-backend string Keyring backend to use. Options are file or system (default "file")
--keyring-namespace string Service name to use when using the system backend (default "defradb")
--keyring-path string Path (relative to DefraDB root directory) to store encrypted keys when using the file backend (default "keys")
--log-format string Log format to use. Options are text or json (default "text")
--log-level string Log level to use. Options are debug, info, error, fatal (default "info")
--log-output string Log output path. Options are stderr or stdout. (default "stderr")
--log-overrides string Logger config overrides. Format <name>,<key>=<val>,...;<name>,...
--log-source Include source location in logs
--log-stacktrace Include stacktrace in error and fatal logs
--no-log-color Disable colored log output
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--secret-file string Path to the file containing secrets (default ".env")

SEE ALSO​