diff --git a/README.md b/README.md index 5ad92581..b37e90a7 100755 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This is a CLI tool to help automate the setup and management of Hashicorp Vault. It will continuously attempt to unseal the target Vault instance, by retrieving -unseal keys from a Google Cloud KMS keyring. +unseal keys from a Google Cloud, AWS KMS keyring or local in path Usage: vault-unsealer [command] @@ -18,7 +18,8 @@ Usage: Available Commands: help Help about any command init Initialise the target Vault instance - unseal A brief description of your command + unseal Unseal the target vault using selected mode + version Print the version number of vault-unsealer Flags: --aws-kms-key-id string The ID or ARN of the AWS KMS key to encrypt values @@ -30,7 +31,8 @@ Flags: --google-cloud-storage-bucket string The name of the Google Cloud Storage bucket to store values in --google-cloud-storage-prefix string The prefix to use for values store in Google Cloud Storage -h, --help help for vault-unsealer - --mode string Select the mode to use 'google-cloud-kms-gcs' => Google Cloud Storage with encryption using Google KMS; 'aws-kms-ssm' => AWS SSM parameter store using AWS KMS encryption (default "google-cloud-kms-gcs") + --local-key-dir string Directory of key shares in path + --mode string Select the mode to use 'google-cloud-kms-gcs' => Google Cloud Storage with encryption using Google KMS; 'aws-kms-ssm' => AWS SSM parameter store using AWS KMS encryption; local => Use local keys in path (default "google-cloud-kms-gcs") --secret-shares int Total count of secret shares that exist (default 1) --secret-threshold int Minimum required secret shares to unseal (default 1)