forked from Consensys/doc.goquorum
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
353 lines (347 loc) · 20.7 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# Copyright 2019 ConsenSys AG.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.
# Project information
site_name: GoQuorum
site_url: https://docs.goquorum.consensys.net/
site_description: A permissioned implementation of Ethereum supporting data privacy
site_author: GoQuorum community
copyright: GoQuorum is licensed under GPLv3 License /
This documentation is maintained by <a href="https://consensys.net/">ConsenSys</a>.
#extra project info and template customisation
extra:
logo_is_text: true
latest_version_warning:
url_contains: /latest/
text: 'You are reading GoQuorum 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.'
support:
company: ConsenSys
tool: Discord
faq: https://consensys.net/quorum/faq
channel: https://discord.gg/5U9Jwp7
email: quorum@consensys.net
website: https://consensys.net/
lead_gen: https://consensys.net/quorum/contact-us
issues: https://github.com/ConsenSys/quorum/issues
google:
site_verification: 'VL2MgMm7Gj-fEOH3SkAuP4eXOY7rIShFFbTI5RktuA0'
tag_manager: 'GTM-PMVS8WR'
inverted_logo: 'images/inverted_logo.svg'
# Software Repository
repo_name: ConsenSys/quorum
repo_url: https://github.com/ConsenSys/quorum.git
theme:
name: material
custom_dir: common/custom_theme
font:
text: 'Roboto'
code: 'Roboto Mono'
language: 'en'
logo: 'images/logo.svg'
favicon: 'images/favicon.svg'
nav:
- Get started:
- Overview: GetStarted/GettingStartedOverview.md
- Upgrade to 2.6.0: GetStarted/migration.md
- Concepts:
- Blockchain:
- Introduction: Concepts/Blockchain/What-is-blockchain.md
- Components: Concepts/Blockchain/Blockchain-comprises.md
- Architecture: Concepts/Architecture.md
- Consensus:
- Overview: Concepts/Consensus/Overview.md
- Comparing PoA consensus protocols: Concepts/Consensus/Comparing-PoA.md
- Account management: Concepts/AccountManagement.md
- Privacy:
- Overview: Concepts/Privacy/Privacy.md
- Public and private transactions: Concepts/Privacy/PrivateAndPublic.md
- Privacy enhancements: Concepts/Privacy/PrivacyEnhancements.md
- Privacy marker transactions: Concepts/Privacy/PrivacyMarkerTransactions.md
- Private transaction lifecycle: Concepts/Privacy/PrivateTransactionLifecycle.md
- Contract state extension: Concepts/Privacy/ContractExtension.md
- Permissioning: Concepts/PermissionsOverview.md
- Plugins: Concepts/Plugins.md
- Security framework: Concepts/SecurityFramework.md
- Multi-tenancy: Concepts/Multitenancy.md
- Quorum profiling: Concepts/Profiling.md
- Network and chain ID: Concepts/NetworkAndChainID.md
- Free gas networks: Concepts/FreeGasNetwork.md
- Deployment:
- Install binaries: Deployment/Binaries.md
- Ansible: Deployment/Ansible.md
- Docker and Docker Compose: Deployment/Docker-and-compose.md
- Kubernetes: Deployment/Kubernetes.md
- Develop applications:
- Connect to a node: DevelopingApplications/Connecting-to-a-node.md
- JSON-RPC APIs: DevelopingApplications/JSON-RPC-APIs.md
- Client libraries: DevelopingApplications/Client-Libraries.md
- Smart contracts and transactions: DevelopingApplications/Smart-Contracts-Transactions.md
- Manage keys:
- Overview: DevelopingApplications/ManageKeys/ManagingKeys.md
- Use clef: DevelopingApplications/ManageKeys/clef.md
- Use account plugins: DevelopingApplications/ManageKeys/AccountPlugins.md
- Develop plugins: DevelopingApplications/DevelopPlugins.md
- How to:
- Configure GoQuorum:
- Consensus protocols:
- IBFT: HowTo/Configure/Consensus-Protocols/IBFT.md
- QBFT: HowTo/Configure/Consensus-Protocols/QBFT.md
- Raft: HowTo/Configure/Consensus-Protocols/Raft.md
- Clique: HowTo/Configure/Consensus-Protocols/Clique.md
- Create a genesis file: HowTo/Configure/GenesisOptions.md
- Predeploy a contract in the genesis file: HowTo/Configure/Contracts-in-Genesis.md
- Bootnodes: HowTo/Configure/Bootnodes.md
- Static nodes: HowTo/Configure/StaticNodes.md
- High availability: HowTo/Configure/HighAvailability.md
- Permissioning:
- Basic permissions: HowTo/Configure/Permissioning/BasicPermissions.md
- Enhanced permissions: HowTo/Configure/Permissioning/EnhancedPermissions.md
- Private transaction manager: HowTo/Configure/ConfigurePTM.md
- DNS: HowTo/Configure/dns.md
- Use:
- Add nodes to network: HowTo/Use/adding_nodes.md
- Migrate network nodes: HowTo/Use/node_network_migration.md
- JSON-RPC API security: HowTo/Use/JSON-RPC-API-Security.md
- Enhanced permissions: HowTo/Use/EnhancedPermissions.md
- Multi-tenancy:
- Use multi-tenancy: HowTo/Use/Multitenancy/Multitenancy.md
- Multiple private states migration: HowTo/Use/Multitenancy/Migration.md
- Include revert reason: HowTo/Use/Revert-Reason.md
- GraphQL: HowTo/Use/graphql.md
- Backup and restore: HowTo/Use/import-export.md
- Monitor nodes:
- Use metrics: HowTo/Monitor/Metrics.md
- Use Elastic Stack: HowTo/Monitor/Elastic-Stack.md
- Use Quorum Hibernate: HowTo/Monitor/Quorum-Hibernate.md
- Use Splunk: HowTo/Monitor/Splunk.md
- Use Cakeshop: HowTo/Monitor/Cakeshop.md
- Use Quorum Reporting: HowTo/Monitor/Quorum-Reporting.md
- Tutorials:
- Quorum Dev Quickstart:
- Getting started: Tutorials/Quorum-Dev-Quickstart/Getting-Started.md
- Using the quickstart: Tutorials/Quorum-Dev-Quickstart/Using-the-Quickstart.md
- Remix: Tutorials/Quorum-Dev-Quickstart/Remix.md
- Create a private network:
- Using IBFT: Tutorials/Private-Network/Create-IBFT-Network.md
- Using QBFT: Tutorials/Private-Network/Create-QBFT-Network.md
- Using Raft: Tutorials/Private-Network/Create-a-Raft-network.md
- Adding and removing IBFT validators: Tutorials/Private-Network/Adding-removing-IBFT-validators.md
- Adding and removing QBFT validators: Tutorials/Private-Network/Adding-removing-QBFT-validators.md
- Smart contracts and transactions:
- Deploy a contract: Tutorials/Contracts/Deploying-Contracts.md
- Interact with a deployed contract: Tutorials/Contracts/Calling-Contract-Functions.md
- Transfer account funds: Tutorials/Contracts/Account-Funds-Transfers.md
- Create a privacy-enabled network: Tutorials/Create-Privacy-enabled-network.md
- Send private transactions: Tutorials/Send-private-transaction.md
- Create a permissioned network: Tutorials/CreatePermissionedNetwork.md
- Use a plugin: Tutorials/Use-Plugin.md
- Reference:
- Command line options: Reference/CLI-Syntax.md
- GoQuorum API methods: Reference/API-Methods.md
- Permissioning types: Reference/Permissioning-Types.md
- Genesis file items: Reference/genesis.md
- Plugins:
- account: Reference/Plugins/Account.md
- security: Reference/Plugins/Security.md
- Accounts for testing: Reference/Accounts-for-Testing.md
- GoQuorum projects: Reference/GoQuorum-Projects.md
- Logging and errors: Reference/Logging and Errors.md
- Web3js-quorum: Reference/web3js-quorum.md
markdown_extensions:
- toc:
permalink:
toc_depth: 3
- codehilite
- pymdownx.tabbed
- pymdownx.superfences
- markdown_include.include:
base_path: docs
- 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.tasklist:
custom_checkbox: true
- pymdownx.tilde
- meta
- smarty
- attr_list
- plantuml_markdown:
server: http://www.plantuml.com/plantuml
plugins:
- search:
lang: 'en'
separator: '[\s\-\.\_]+'
- markdownextradata
- exclude:
glob:
- global/*
- git-revision-date-localized:
locale: en
- redirects:
redirect_maps:
# Configure redirects using key:value pairs:
# old_path.md: new_path.md
# you can't use an already redirected path as an old_path.
# new_path can be a file inside the docs/ folder or any URL (http://...)
GetStarted/Install.md: Deployment/Binaries.md
Account-Key-Management/Overview.md: Concepts/AccountManagement.md
Account-Key-Management/Quorum/Overview.md: Concepts/AccountManagement.md
Account-Key-Management/Quorum/Clef.md: DevelopingApplications/ManageKeys/clef.md
Account-Key-Management/Quorum/Keystore-Files.md: DevelopingApplications/ManageKeys/ManagingKeys.md
Account-Key-Management/Quorum/account-Plugins/Overview.md: DevelopingApplications/ManageKeys/AccountPlugins.md
HowTo/ManageKeys/Clef.md: DevelopingApplications/ManageKeys/clef.md
HowTo/ManageKeys/ManagingKeys.md: DevelopingApplications/ManageKeys/ManagingKeys.md
HowTo/ManageKeys/AccountPlugins.md: DevelopingApplications/ManageKeys/AccountPlugins.md
Account-Key-Management/Tessera/Overview.md: Concepts/AccountManagement.md
Consensus/ibft/ibft.md: HowTo/Configure/Consensus-Protocols/IBFT.md
Consensus/Consensus.md: Concepts/Consensus/Overview.md
Consensus/raft/raft.md: HowTo/Configure/Consensus-Protocols/Raft.md
Getting Started/permissioned-nodes.md: HowTo/Configure/Permissioning/BasicPermissions.md
Getting Started/running.md: GetStarted/GettingStartedOverview.md
Consensus/ibft/ibft-parameters.md: HowTo/Configure/Consensus-Protocols/IBFT.md
Consensus/ibft/istanbul-rpc-api.md: Reference/API-Methods.md
Consensus/raft/raft-rpc-api.md: Reference/API-Methods.md
Permissioning/Basic NetworkPermissions.md: HowTo/Configure/Permissioning/BasicPermissions.md
Permissioning/Enhanced Permissions Model/Contract Design.md: Concepts/PermissionsOverview.md
Permissioning/Permissions Overview.md: Concepts/PermissionsOverview.md
PluggableArchitecture/Overview.md: Concepts/Plugins.md
PluggableArchitecture/Internals.md: Concepts/Plugins.md
Privacy/Contract-Extension/Overview.md: Concepts/Privacy/ContractExtension.md
Privacy/Overview.md: Concepts/Privacy/PrivateAndPublic.md
Privacy/Lifecycle-of-a-private-transaction.md: Concepts/Privacy/PrivateTransactionLifecycle.md
Privacy/Privacy-Manager.md: Concepts/Privacy/Privacy.md
Security/Framework/Decentralized Application/Frontend Components.md: Concepts/SecurityFramework.md
Security/Framework/Decentralized Application/Smart Contracts Security.md: Concepts/SecurityFramework.md
Security/Framework/Quorum Network Security/Consortium.md: Concepts/SecurityFramework.md
Security/Framework/Quorum Network Security/Node.md: Concepts/SecurityFramework.md
Security/Framework/Quorum Network Security/Opertional Considerations.md: Concepts/SecurityFramework.md
Security/Framework/Quorum Network Security/Transaction Manager.md: Concepts/SecurityFramework.md
Security/Framework/Overview.md: Concepts/SecurityFramework.md
How-To-Guides/HA_Setup.md: HowTo/Configure/HighAvailability.md
How-To-Guides/add_ibft_validator.md: Tutorials/Private-Network/Adding-removing-IBFT-validators.md
Permissioning/Enhanced Permissions Model/setup.md: HowTo/Configure/Permissioning/EnhancedPermissions.md
Quorum Features/dns.md: HowTo/Configure/dns.md
PluggableArchitecture/PluginDevelopment.md: DevelopingApplications/DevelopPlugins.md
HowTo/DevelopPlugins.md: DevelopingApplications/DevelopPlugins.md
HowTo/GetStarted/Cakeshop.md: HowTo/Monitor/Cakeshop.md
Cakeshop/Getting started.md: HowTo/Monitor/Cakeshop.md
Getting Started/Getting Started Overview.md: GetStarted/GettingStartedOverview.md
Getting Started/Installing.md: Deployment/Binaries.md
Wizard/GettingStarted.md: Tutorials/Quorum-Dev-Quickstart/Getting-Started.md
Wizard/Interacting.md: Tutorials/Quorum-Dev-Quickstart/Using-the-Quickstart.md
Getting Started/migration.md: GetStarted/migration.md
Permissioning/Enhanced Permissions Model/Usage.md: HowTo/Use/EnhancedPermissions.md
Quorum Features/rpc-security.md: HowTo/Use/JSON-RPC-API-Security.md
How-To-Guides/add_node_examples.md: HowTo/Use/adding_nodes.md
How-To-Guides/adding_nodes.md: HowTo/Use/adding_nodes.md
Getting Started/graphql.md: HowTo/Use/graphql.md
How-To-Guides/import-export.md: HowTo/Use/import-export.md
Privacy/Contract-Extension/ContractExtension apis.md: Reference/API-Methods.md
Permissioning/Enhanced Permissions Model/Permissioning apis.md: Reference/API-Methods.md
Getting Started/api.md: Reference/API-Methods.md
Reference/CakeshopFAQ.md: HowTo/Monitor/Cakeshop.md
Cakeshop/Cakeshop FAQ.md: HowTo/Monitor/Cakeshop.md
Cakeshop/Overview.md: HowTo/Monitor/Cakeshop.md
FAQ.md: https://consensys.net/quorum/faq/
Getting Started/Quorum-Examples.md: Reference/GoQuorum-Projects.md
PluggableArchitecture/Plugins/account/For-Developers.md: Reference/Plugins/Account.md
PluggableArchitecture/Plugins/account/For-Users.md: Reference/Plugins/Account.md
PluggableArchitecture/Plugins/account/interface.md: Reference/Plugins/Account.md
PluggableArchitecture/Plugins/helloworld/implementation.md: Tutorials/Use-Plugin.md
PluggableArchitecture/Plugins/helloworld/interface.md: Tutorials/Use-Plugin.md
PluggableArchitecture/Plugins/init_interface.md: https://github.com/ConsenSys/quorum-plugin-definitions/blob/master/init.proto
PluggableArchitecture/Plugins/security/implementation.md: Reference/Plugins/Security.md
PluggableArchitecture/Plugins/security/interface.md: Reference/Plugins/Security.md
RemixPlugin/GettingStarted.md: Tutorials/Quorum-Dev-Quickstart/Remix.md
RemixPlugin/Overview.md: Tutorials/Quorum-Dev-Quickstart/Remix.md
Getting Started/genesis.md: Reference/genesis.md
quorum.js/Overview.md: DevelopingApplications/Client-Libraries.md
quorum.js/RawTransactionManager.md: DevelopingApplications/Client-Libraries.md
quorum.js/extend.md: DevelopingApplications/Client-Libraries.md
Tutorials/Creating-A-Network-From-Scratch.md: Tutorials/Private-Network/Create-IBFT-Network.md
Tutorials/Create-a-Raft-network.md: Tutorials/Private-Network/Create-a-Raft-network.md
HowTo/GetStarted/monitoring.md: HowTo/Monitor/Metrics.md
Reference/APIs/PrivacyAPI.md: Reference/API-Methods.md
Reference/APIs/PrivacyEnhancementsAPIs.md: Reference/API-Methods.md
Reference/APIs/PermissioningAPIs.md: Reference/API-Methods.md
Reference/APIs/ContractExtensionAPIs.md: Reference/API-Methods.md
Reference/APIs/DebugAPIs.md: Reference/API-Methods.md
Reference/Consensus/IBFTParameters.md: HowTo/Configure/Consensus-Protocols/IBFT.md
Reference/Consensus/IBFT-RPC-API.md: Reference/API-Methods.md
Reference/Consensus/Raft-RPC-API.md: Reference/API-Methods.md
HowTo/Use/AddingIBFTValidators.md: Tutorials/Private-Network/Adding-removing-IBFT-validators.md
HowTo/Use/add_node_examples.md: HowTo/Use/adding_nodes.md
Concepts/Consensus/IBFT.md: HowTo/Configure/Consensus-Protocols/IBFT.md
Concepts/Consensus/Raft.md: HowTo/Configure/Consensus-Protocols/Raft.md
Concepts/Consensus/Lifecycle-Raft-transaction.md: HowTo/Configure/Consensus-Protocols/Raft.md
Concepts/Consensus/Raft-implementation.md: HowTo/Configure/Consensus-Protocols/Raft.md
Reference/IBFTParameters.md: HowTo/Configure/Consensus-Protocols/IBFT.md
HowTo/GetStarted/GettingStartedOverview.md: GetStarted/GettingStartedOverview.md
HowTo/GetStarted/Install.md: Deployment/Binaries.md
HowTo/GetStarted/migration.md: GetStarted/migration.md
HowTo/GetStarted/Getting-Started-Qubernetes.md: Deployment/Kubernetes.md
GetStarted/Getting-Started-Qubernetes.md: Deployment/Kubernetes.md
Concepts/Cakeshop.md: HowTo/Monitor/Cakeshop.md
Reference/Cakeshop/GettingStarted.md: HowTo/Monitor/Cakeshop.md
Reference/Cakeshop/Configuration.md: HowTo/Monitor/Cakeshop.md
Tutorials/Quorum-Dev-Quickstart/Tools.md: Tutorials/Quorum-Dev-Quickstart/Getting-Started.md
Tutorials/Connecting-to-a-node.md: DevelopingApplications/Connecting-to-a-node.md
Concepts/Permissioning/PermissionsOverview.md: Concepts/PermissionsOverview.md
Concepts/Permissioning/BasicNetworkPermissions.md: HowTo/Configure/Permissioning/BasicPermissions.md
Concepts/Permissioning/Enhanced/EnhancedPermissionsOverview.md: Concepts/PermissionsOverview.md
Concepts/Permissioning/Enhanced/ContractDesign.md: Concepts/PermissionsOverview.md
HowTo/Configure/BasicPermissions.md: HowTo/Configure/Permissioning/BasicPermissions.md
HowTo/Configure/EnhancedPermissions.md: HowTo/Configure/Permissioning/EnhancedPermissions.md
Reference/quorum.js/Overview.md: DevelopingApplications/Client-Libraries.md
Reference/quorum.js/extend.md: DevelopingApplications/Client-Libraries.md
HowTo/Interact/Client-Libraries/web3js-quorum.md: DevelopingApplications/Client-Libraries.md
HowTo/Interact/API.md: DevelopingApplications/Connecting-to-a-node.md
Reference/quorum.js/RawTransactionManager.md: DevelopingApplications/Client-Libraries.md
Concepts/Privacy/PrivateTransactionManager.md: Concepts/Privacy/Privacy.md
HowTo/Use/DevelopingSmartContracts.md: Tutorials/Contracts/Deploying-Contracts.md
Concepts/Plugins/PluginsArchitecture.md: Concepts/Plugins.md
Concepts/Plugins/Plugins.md: Concepts/Plugins.md
HowTo/Configure/Plugins.md: DevelopingApplications/DevelopPlugins.md
Tutorials/Adding-removing-IBFT-validators.md: Tutorials/Private-Network/Adding-removing-IBFT-validators.md
PluggableArchitecture/Plugins/security/For-Users.md: Reference/Plugins/Security.md
Reference/Plugins/account/For-Developers.md: Reference/Plugins/Account.md
Reference/Plugins/account/For-Users.md: Reference/Plugins/Account.md
Reference/Plugins/account/interface.md: Reference/Plugins/Account.md
Reference/Plugins/security/For-Developers.md: Reference/Plugins/Security.md
Reference/Plugins/security/For-Users.md: Reference/Plugins/Security.md
Reference/Plugins/security/interface.md: Reference/Plugins/Security.md
Reference/Plugins/helloworld/interface.md: https://github.com/ConsenSys/quorum-plugin-definitions/blob/master/helloworld.proto
Reference/Plugins/helloworld/implementation.md: Tutorials/Use-Plugin.md
Reference/Plugins/init_interface.md: https://github.com/ConsenSys/quorum-plugin-definitions/blob/master/init.proto
HowTo/Use/Multitenancy.md: HowTo/Use/Multitenancy/Multitenancy.md
Concepts/Multitenancy/MultiplePrivateStates.md: Concepts/Multitenancy.md
Concepts/Multitenancy/Overview.md: Concepts/Multitenancy.md
Concepts/Security/Framework/Overview.md: Concepts/SecurityFramework.md
Concepts/Security/Framework/GoQuorumNetworkSecurity/Consortium.md: Concepts/SecurityFramework.md
Concepts/Security/Framework/GoQuorumNetworkSecurity/Node.md: Concepts/SecurityFramework.md
Concepts/Security/Framework/GoQuorumNetworkSecurity/TransactionManager.md: Concepts/SecurityFramework.md
Concepts/Security/Framework/GoQuorumNetworkSecurity/OpertionalConsiderations.md: Concepts/SecurityFramework.md
Concepts/Security/Framework/DecentralizedApplication/FrontendComponents.md: Concepts/SecurityFramework.md
Concepts/Security/Framework/DecentralizedApplication/SmartContractsSecurity.md: Concepts/SecurityFramework.md
Concepts/Qubernetes/Qubernetes-Overview.md: Deployment/Kubernetes.md
Concepts/Qubernetes/Multicluster.md: Deployment/Kubernetes.md
Reference/FAQ.md: https://consensys.net/quorum/faq/