2019-05-02 09:38:58 -07:00
|
|
|
|
|
|
|
# Project information
|
|
|
|
site_name: Quorum
|
2019-05-02 14:55:22 -07:00
|
|
|
site_url: https://docs.goquorum.com/
|
2019-05-02 09:38:58 -07:00
|
|
|
site_description: A permissioned implementation of Ethereum supporting data privacy
|
|
|
|
site_author: Quorum
|
|
|
|
copyright: Quorum 2019
|
|
|
|
|
|
|
|
# Repository
|
|
|
|
repo_name: quorum
|
|
|
|
repo_url: https://github.com/jpmorganchase/quorum
|
|
|
|
|
|
|
|
nav:
|
2020-04-18 10:24:34 -07:00
|
|
|
- Home: index.md
|
2019-05-02 09:38:58 -07:00
|
|
|
- Getting Started:
|
2020-04-14 12:30:10 -07:00
|
|
|
- Quickstart: Getting Started/Getting Started Overview.md
|
2019-07-17 13:01:30 -07:00
|
|
|
- Installing: Getting Started/Installing.md
|
2019-09-11 07:13:39 -07:00
|
|
|
- Examples: Getting Started/Quorum-Examples.md
|
2019-07-17 13:01:30 -07:00
|
|
|
- Creating a Network From Scratch: Getting Started/Creating-A-Network-From-Scratch.md
|
2019-05-02 09:38:58 -07:00
|
|
|
- Running Quorum: Getting Started/running.md
|
2019-06-10 07:42:20 -07:00
|
|
|
- Quorum API: Getting Started/api.md
|
2020-04-29 07:50:56 -07:00
|
|
|
- Quorum GraphQL: Getting Started/graphql.md
|
2020-05-12 12:42:08 -07:00
|
|
|
- Migration: Getting Started/migration.md
|
|
|
|
- Quorum Features:
|
|
|
|
- Transaction/Contract Privacy:
|
|
|
|
- Overview: Privacy/Overview.md
|
|
|
|
- Privacy/Privacy-Manager.md
|
|
|
|
- Privacy/Lifecycle-of-a-private-transaction.md
|
|
|
|
- Tessera:
|
|
|
|
- What is Tessera: Privacy/Tessera/Tessera.md
|
|
|
|
- Configuration:
|
|
|
|
- Overview: Privacy/Tessera/Configuration/Configuration Overview.md
|
|
|
|
- Keys Config: Privacy/Tessera/Configuration/Keys.md
|
|
|
|
- TLS Config: Privacy/Tessera/Configuration/TLS.md
|
|
|
|
- Using CLI to override config: Privacy/Tessera/Configuration/Using CLI to override config.md
|
|
|
|
- Sample Configuration: Privacy/Tessera/Configuration/Sample Configuration.md
|
|
|
|
- Tessera Services:
|
|
|
|
- Transaction Manager: Privacy/Tessera/Tessera Services/Transaction Manager.md
|
|
|
|
- Enclave: Privacy/Tessera/Tessera Services/Enclave.md
|
|
|
|
- Keys:
|
|
|
|
- Key Generation: Privacy/Tessera/Tessera Services/Keys/Keys.md
|
|
|
|
- Setting up Hashicorp Vault: Privacy/Tessera/Tessera Services/Keys/Setting up a Hashicorp Vault.md
|
|
|
|
- Setting up Azure Key Vault: Privacy/Tessera/Tessera Services/Keys/Setting up an Azure Key Vault.md
|
|
|
|
- Setting up AWS Secrets Manager: Privacy/Tessera/Tessera Services/Keys/Setting up an AWS Secrets Manager.md
|
|
|
|
- Usage:
|
|
|
|
- Interfaces & API: Privacy/Tessera/Usage/Interface & API.md
|
|
|
|
- Admin Usage: Privacy/Tessera/Usage/Admin Usage.md
|
|
|
|
- Monitoring: Privacy/Tessera/Usage/Monitoring.md
|
|
|
|
- Logging: Privacy/Tessera/Usage/Logging.md
|
|
|
|
- Migration from Constellation: Privacy/Tessera/Migration from Constellation.md
|
|
|
|
- Constellation:
|
|
|
|
- What is Constellation: Privacy/Constellation/Constellation.md
|
|
|
|
- How it works: Privacy/Constellation/How constellation works.md
|
|
|
|
- Sample Configuration: Privacy/Constellation/Sample Configuration.md
|
|
|
|
- Running Constellation: Privacy/Constellation/Installation & Running.md
|
|
|
|
- Consensus:
|
|
|
|
- Consensus: Consensus/Consensus.md
|
|
|
|
- Raft BFT:
|
|
|
|
- Consensus/raft/raft.md
|
|
|
|
- Consensus/raft/raft-rpc-api.md
|
|
|
|
- Istanbul BFT:
|
|
|
|
- Overview: Consensus/ibft/ibft.md
|
|
|
|
- Consensus/ibft/istanbul-rpc-api.md
|
|
|
|
- Consensus/ibft/ibft-parameters.md
|
|
|
|
- Permissioning:
|
|
|
|
- Overview: Permissioning/Permissions Overview.md
|
|
|
|
- Basic: Permissioning/Basic NetworkPermissions.md
|
|
|
|
- Enhanced:
|
|
|
|
- Overview: Permissioning/Enhanced Permissions Model/Overview.md
|
|
|
|
- Design: Permissioning/Enhanced Permissions Model/Contract Design.md
|
|
|
|
- Setup: Permissioning/Enhanced Permissions Model/setup.md
|
|
|
|
- APIs: Permissioning/Enhanced Permissions Model/Permissioning apis.md
|
|
|
|
- Usage: Permissioning/Enhanced Permissions Model/Usage.md
|
|
|
|
- Pluggable Architecture:
|
|
|
|
- Overview: PluggableArchitecture/Overview.md
|
|
|
|
- Settings: PluggableArchitecture/Settings.md
|
|
|
|
- Internals: PluggableArchitecture/Internals.md
|
|
|
|
- Plugins:
|
|
|
|
- helloworld:
|
|
|
|
- Interface: PluggableArchitecture/Plugins/helloworld/interface.md
|
|
|
|
- Implementation: PluggableArchitecture/Plugins/helloworld/implementation.md
|
|
|
|
- Plugin Development: PluggableArchitecture/PluginDevelopment.md
|
|
|
|
- DNS: Quorum Features/dns.md
|
|
|
|
- Quorum Projects:
|
|
|
|
- Quorum Wizard:
|
|
|
|
- Getting Started: Wizard/GettingStarted.md
|
|
|
|
- Interacting with the Network: Wizard/Interacting.md
|
|
|
|
- Cakeshop:
|
|
|
|
- Overview: Cakeshop/Overview.md
|
|
|
|
- Getting Started: Cakeshop/Getting started.md
|
|
|
|
- Cakeshop FAQ: Cakeshop/Cakeshop FAQ.md
|
|
|
|
- Remix Plugin:
|
|
|
|
- Overview: RemixPlugin/Overview.md
|
|
|
|
- Getting Started: RemixPlugin/GettingStarted.md
|
|
|
|
- quorum.js:
|
|
|
|
- Overview: quorum.js/Overview.md
|
|
|
|
- extend API: quorum.js/extend.md
|
|
|
|
- RawTransactionManager API: quorum.js/RawTransactionManager.md
|
2020-04-18 10:24:34 -07:00
|
|
|
- Security Framework:
|
|
|
|
- Overview: Security/Framework/Overview.md
|
|
|
|
- Quorum Network:
|
|
|
|
- Consortium: Security/Framework/Quorum Network Security/Consortium.md
|
2020-05-12 12:42:08 -07:00
|
|
|
- Quorum Node: Security/Framework/Quorum Network Security/Node.md
|
2020-04-18 10:24:34 -07:00
|
|
|
- Transaction Manager: Security/Framework/Quorum Network Security/Transaction Manager.md
|
|
|
|
- Operational Considerations: Security/Framework/Quorum Network Security/Opertional Considerations.md
|
|
|
|
- Decentralized App:
|
|
|
|
- Frontend: Security/Framework/Decentralized Application/Frontend Components.md
|
2020-05-12 12:42:08 -07:00
|
|
|
- Smart Contracts: Security/Framework/Decentralized Application/Smart Contracts Security.md
|
2020-01-23 10:40:57 -08:00
|
|
|
- How-To Guides:
|
|
|
|
- Adding new nodes: How-To-Guides/adding_nodes.md
|
|
|
|
- Adding IBFT validators: How-To-Guides/add_ibft_validator.md
|
2020-04-29 07:50:56 -07:00
|
|
|
- Backup & Restore: How-To-Guides/import-export.md
|
|
|
|
- External Signer with Clef: How-To-Guides/external-signer.md
|
2019-11-29 06:42:02 -08:00
|
|
|
- Product Roadmap: roadmap.md
|
2019-05-20 04:41:37 -07:00
|
|
|
- FAQ: FAQ.md
|
2019-05-02 09:38:58 -07:00
|
|
|
|
|
|
|
theme:
|
|
|
|
name: 'material'
|
|
|
|
custom_dir: 'docs/theme'
|
|
|
|
font:
|
|
|
|
text: 'Roboto'
|
|
|
|
code: 'Roboto Mono'
|
|
|
|
language: 'en'
|
|
|
|
logo: 'images/logo.png'
|
2019-05-23 15:37:52 -07:00
|
|
|
favicon: 'images/logo-48x48.png'
|
2019-05-02 09:38:58 -07:00
|
|
|
|
|
|
|
extra_css:
|
|
|
|
- 'theme/assets/stylesheets/extra.css'
|
|
|
|
|
|
|
|
markdown_extensions:
|
|
|
|
- toc:
|
|
|
|
permalink: true
|
|
|
|
toc_depth: 3
|
2020-04-10 10:57:01 -07:00
|
|
|
- attr_list
|
2019-05-02 09:38:58 -07:00
|
|
|
- codehilite
|
|
|
|
- admonition
|
|
|
|
- footnotes
|
|
|
|
- def_list
|
|
|
|
- abbr
|
|
|
|
- pymdownx.arithmatex
|
|
|
|
- pymdownx.betterem:
|
|
|
|
smart_enable: all
|
|
|
|
- pymdownx.keys
|
|
|
|
- pymdownx.details
|
|
|
|
- pymdownx.emoji
|
|
|
|
- pymdownx.magiclink
|
|
|
|
- pymdownx.mark
|
|
|
|
- pymdownx.smartsymbols
|
|
|
|
- pymdownx.superfences
|
|
|
|
- pymdownx.tasklist:
|
|
|
|
custom_checkbox: true
|
|
|
|
- pymdownx.tilde
|
2020-02-28 12:19:08 -08:00
|
|
|
- markdown_include.include:
|
|
|
|
base_path: docs
|
2019-05-02 09:38:58 -07:00
|
|
|
- meta
|
|
|
|
- smarty
|
2020-02-28 12:19:08 -08:00
|
|
|
- plantuml_markdown:
|
|
|
|
server: http://www.plantuml.com/plantuml
|
2019-05-02 09:38:58 -07:00
|
|
|
|
|
|
|
plugins:
|
|
|
|
- search
|