Skip to main content
Version: 1.0 RC1 (Latest)

defradb_keyring

defradb keyring​

Manage DefraDB private keys

Synopsis​

Manage DefraDB private keys. Generate, add, get, and list private keys.

The following keys are loaded from the keyring on start:

  • peer-key: Ed25519 key (required)
  • encryption-key: AES-128, AES-192, or AES-256 key (optional)

Examples​

Randomly generate the required keys:  
  defradb keyring new

Import externally generated keys:  
  defradb keyring add <name> <private-key-hex>

Options​

  -h, --help   help for keyring

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 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-keyring                  Disable the keyring and generate ephemeral keys
      --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")
      --source-hub-address string   The SourceHub address authorized by the client to make SourceHub transactions on behalf of the actor
      --url string                  URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")

SEE ALSO​

defradb_keyring
Edit this page