consensys/doc.quorum-key-manager

Quorum Key Manager documentation

ConsenSys Quorum Key Manager

This documentation repo is built using Docusaurus 2.

Local Development

$ npm install
$ npm run prepare
$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

doc.quorum-key-manager's Issues

Rename meta-txn page

Rename this tutorial to "Send an Infura ITX meta-transaction."

Migrate Quorum Key Manager doc to new Doctools

See https://github.com/ConsenSys/doc.quorum-key-manager for doc source code.

To do

• Create a github issue for migrating this doc (on the doc repos)
• Exact site name: no change
• Expected domain: https://consensys.net/docs/quorum-key-manager/
• Logo (SVG): no change
• Colour palette: no change
• Define content license: no change
• integrate design elements (no change for now, migrating as is)
• Have agreement from the Tessera team
• Make sure all pending PRs are merged before starting
• Disable Github repos interaction for 1 week to make sure no collisions in PRs
• Disable Github webhooks with RTD and Circle CI
• Disable Circle CI build (in circle project config)
• Create a new main branch from master (next default will be main)
• Remove everything except /docs content and mkdocs.yml file
• Copy files from doctools.template except /docs
• Update mkdocs.*.yml files
• Update Docker compose file
• Preview the site locally
• Make adjustments (logo, favicon)
• Update Readme
• Create production and preview environments on Github
• Create production secrets (see doctools.template)
• Create the Cloudflare KV entry
• Push the main branch to upstream: the migration has to be on a branch in the upstream repos, not a fork!
• Create a first PR to activate workflows (add “fixes #” to close the initial issue automatically
• Setup branch rule for main and require workflow
• Setup @ConsenSys/consensys-docops team as admin on repo and keep @ConsenSys/protocol-pliny as maintainers
• Test the new doc site is published on new URL consensys.net/docs/quorum-key-manager
• Setup main as default branch
• Create release for the latest stable version
• Update Cloudflare DNS CNAMEs
• Test the old doc site domain redirects to the new docs.quorum-key-manager.consensys.net
• Restore Github interactions
• Communicate on the new doc site

ConsenSys product contact

#team-quorum-key-manager (PM @julien-marchand )

Document CLI reference content

Will need to wait until we have a working application to test.

Document installation procedure

Will need to wait until we have a working application to test

Remove reference to paid professional support

The footer currently contains the following which needs to be removed:
For paid professional support by ConsenSys, contact us at [email protected].

Add note for EIP-1559

Add note that QKM supports EIP-1559 transactions.

Add architecture overview content

Document authentication

Documentation a description of authentication and instructions on how to use it.

document synchronization tool

Document synchronization tool to import the public keys of private keys stored in a QKM vault inside the QKM DB.
Demo video: https://consensys.zoom.us/rec/share/9mgyY5k9GL2UC3JdUB9LIAU1-yyoKPMfpGKsCH5GgUrBRFgWTxXGhPYhEFlFBwvt.62usGphUc_FXxYdT Passcode: %54S@#+d

Document nodes concept page

Add concept page for Quorum Key Manager nodes.

update curve name

The BN254 curve was renamed to "Babyjubjub", which is an alias for "BN254 - twisted edwards."

Add content to documentation landing page

add prereq for hashicorp keys

To use HashiCorp Keys, user must install the HashiCorp Vault Plugin (https://github.com/ConsenSys/orchestrate-hashicorp-vault-plugin).

Wrong Environment Variable Name for Setting TLS/SSL Mode

Describe the bug

Documentation for TLS/SSL has the wrong environment variable name DB_SSLMODE:
https://github.com/ConsenSys/doc.quorum-key-manager/blob/127f0e22e7993d0e0da3669af617aee8250a7608/docs/Reference/CLI/CLI-Syntax.md?plain=1#L289

• Missing content
• Outdated content
• Wrong content
• Confusing or misleading content
• Other

Change suggestion

Environment variable name should be DB_TLS_SSLMODE as shown in the docker compose example here:
https://github.com/ConsenSys/quorum-key-manager/blob/d509f52d9ab3d6476327415a6d276f4e570b50e2/docker-compose.yml#L9

Document stores concept page

Add concept page for Quorum Key Manager stores.

doc db command line options

Document all the --db-* command line options for configuring Postgres.

add security disclosure page

Add the same "Security Disclosure Policy" as on EthSigner.

add Infura tutorials

Add tutorial on (1) how to connect QKM with an Infura endpoint, and (2) how to sign a meta-transaction with QKM and send to Infura ITX.
See this doc: https://docs.google.com/document/d/1bEcxZChMSZQfOF2fJFuwdPwrNmFxv2uVMitOPwym6yM/edit#

Add documentation for LTS (Long Term Support)

QKM now provides LTS releases.

Add a page describing the LTS releases and what they mean.

• How long is an LTS release supported?
• Will we be publishing interim releases between LTS releases
• How do users know that a release is an LTS release? (e.g. is it numbered differently)
• How often are LTS releases published?
• What's the difference between interim releases and LTS releases

Replace OIDC with OAuth 2.0

Per Julian Marchand, replace all OpenIdConnect/OIDC in the documentation with OAuth 2.0, which is more accurate.

Page: https://docs.quorum-key-manager.consensys.net/en/latest/HowTo/Authenticate/OIDC/

Add note for Mac users to build from source

Mac users must modify makefile to build from source.

Document authorization

Document a description of authorization and authorization policies, and instructions for how to use authorization.

Document how to configure QKM

Add documentation on how to configure QKM, including example config file.