Skip to content
You are reading Quorum Key Manager development version documentation and some displayed features may not be available in the stable release. You can switch to stable version using the version box at screen bottom.

Index resources

If you have existing Ethereum accounts, keys, or secrets in a secure storage system, you must index (reference) these resources in your local QKM database using the sync subcommand in order to use them.

Use sync ethereum to index Ethereum accounts, sync keys to index keys, and sync secrets to index secrets. You can specify options on the command line or as environment variables.

Important

When you index your resources, the private keys remain in the underlying secure storage system. The keys are loaded into your local database to generate metadata linked to the underlying system.

On the command line

Specify the path to the manifest file in which the store is configured using the --manifest-path command line option, and the name of the store using the --store-name option. Include any database options (any options that begin with --db-) that apply to your local database.

Indexing keys from hashicorp-keys on the command line

key-manager sync keys --manifest-path="/config/default.yml" --store-name="hashicorp-keys" --db-port=8080

As environment variables

You can index resources using environment variables by specifying:

  • The manifest file by using the MANIFEST_PATH environment variable
  • The identifier of the store to index using the SYNC_STORE_NAME environment variable
  • Optional database connection settings, such as DB_DATABASE

Indexing keys from hashicorp-keys as environment variables

    MANIFEST_PATH="/config/default.yml"
    SYNC_STORE_NAME="hashicorp-keys"
key-manager sync keys
Questions or feedback? You can discuss issues and obtain free support on Quorum Key Manager Discord channel.
For paid professional support by Consensys, contact us at [email protected].