forked from hyperledger/besu-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.navigation.yml
194 lines (193 loc) · 12.1 KB
/
mkdocs.navigation.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
---
# 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.
INHERIT: mkdocs.extra.yml # DO NOT MODIFY THIS LINE
nav:
- How to:
- Get started with Besu:
- System requirements:
- Private network: HowTo/Get-Started/System-Requirements/System-Requirements-Private.md
- Public network: HowTo/Get-Started/System-Requirements/System-Requirements-Public.md
- Install Besu:
- Options: HowTo/Get-Started/Installation-Options/Options.md
- Run Besu from Docker image: HowTo/Get-Started/Installation-Options/Run-Docker-Image.md
- Install binary distribution: HowTo/Get-Started/Installation-Options/Install-Binaries.md
- Build from source: HowTo/Get-Started/Installation-Options/Build-from-source.md
- Start Besu: HowTo/Get-Started/Starting-node.md
- Migrate to Besu: HowTo/Get-Started/migrate-to-besu.md
- Configure Besu:
- Consensus protocols:
- QBFT: HowTo/Configure/Consensus-Protocols/QBFT.md
- IBFT 2.0: HowTo/Configure/Consensus-Protocols/IBFT.md
- Clique: HowTo/Configure/Consensus-Protocols/Clique.md
- Create a genesis file: HowTo/Configure/Genesis-File.md
- Specify options in a configuration file: HowTo/Configure/Using-Configuration-File.md
- Configure a free gas network: HowTo/Configure/FreeGas.md
- TLS:
- Client and server TLS: HowTo/Configure/TLS/Configure-TLS.md
- Peer-to-peer TLS: HowTo/Configure/TLS/P2P-TLS.md
- High availability:
- Configure high availability of APIs: HowTo/Configure/Configure-HA/High-Availability.md
- Sample load balancer configurations: HowTo/Configure/Configure-HA/Sample-Configuration.md
- Predeploy a contract in the genesis file: HowTo/Configure/Contracts-in-Genesis.md
- Configure mining: HowTo/Configure/Configure-Mining.md
- Pass JVM options: HowTo/Configure/Passing-JVM-Options.md
- Alternative elliptic curves: HowTo/Configure/Alternative-EC-Curves.md
- Block proposal permissioning: HowTo/Configure/Block-Proposal-Permissioning.md
- Interact with node:
- Besu APIs:
- Access Besu APIs: HowTo/Interact/APIs/API.md
- Use JSON-RPC API over HTTP or WebSockets: HowTo/Interact/APIs/Using-JSON-RPC-API.md
- Use RPC Pub/Sub API over WebSockets: HowTo/Interact/APIs/RPC-PubSub.md
- Use GraphQL over HTTP: HowTo/Interact/APIs/GraphQL.md
- Authenticate JSON-RPC requests: HowTo/Interact/APIs/Authentication.md
- Use the Engine API: HowTo/Interact/APIs/Engine-API.md
- Client libraries:
- Use the web3js-quorum client library: HowTo/Interact/Client-Libraries/web3js-quorum.md
- Filters:
- Access logs using JSON-RPC API: HowTo/Interact/Filters/Accessing-Logs-Using-JSON-RPC.md
- Find and connect to peers:
- Specify bootnodes: HowTo/Find-and-Connect/Bootnodes.md
- Configure static nodes: HowTo/Find-and-Connect/Static-Nodes.md
- Configure ports for access: HowTo/Find-and-Connect/Configuring-Ports.md
- Manage peers: HowTo/Find-and-Connect/Managing-Peers.md
- Specify NAT method: HowTo/Find-and-Connect/Specifying-NAT.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-Enterprise.md
- Use OpenTelemetry: HowTo/Monitor/OpenTelemetry-Collector.md
- Configure logging: HowTo/Monitor/Logging.md
- Send transactions:
- Use wallets for key management: HowTo/Send-Transactions/Account-Management.md
- Create and send transactions: HowTo/Send-Transactions/Transactions.md
- Create and send private transactions: HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md
- Send concurrent private transactions: HowTo/Send-Transactions/Concurrent-Private-Transactions.md
- Include revert reason: HowTo/Send-Transactions/Revert-Reason.md
- Limit access to node:
- Use local permissioning: HowTo/Limit-Access/Local-Permissioning.md
- Update onchain allowlists: HowTo/Limit-Access/Updating-Permission-Lists.md
- Specify interface version: HowTo/Limit-Access/Specify-Perm-Version.md
- Use privacy features:
- Use EEA-compliant privacy: HowTo/Use-Privacy/EEA-Compliant.md
- Use Besu-extended privacy: HowTo/Use-Privacy/Privacy.md
- Create and manage privacy groups: HowTo/Use-Privacy/Create-Manage-Privacy-Groups.md
- Sign privacy marker transactions: HowTo/Use-Privacy/Sign-Privacy-Marker-Transactions.md
- Access private and privacy marker transactions: HowTo/Use-Privacy/Access-Private-Transactions.md
- Run Tessera with Besu: HowTo/Use-Privacy/Run-Tessera-With-Besu.md
- Use flexible privacy: HowTo/Use-Privacy/Use-FlexiblePrivacy.md
- Use GoQuorum-compatible privacy: HowTo/Use-Privacy/Use-GoQuorum-compatible-privacy.md
- Private transaction performance best practices: HowTo/Use-Privacy/Performance-Best-Practices.md
- Deploy for production:
- Deploy to the cloud: HowTo/Deploy/Cloud.md
- Use Ansible to deploy Besu: HowTo/Deploy/Ansible.md
- Use Kubernetes to deploy a private network: HowTo/Deploy/Kubernetes.md
- Configure bootnodes: HowTo/Deploy/Bootnodes.md
- Configure validators: HowTo/Deploy/Validators.md
- Deploy permissioning management dapp: HowTo/Deploy/Production.md
- Use Ethstats network monitor: HowTo/Deploy/Ethstats.md
- Backup and restore: HowTo/Backup/Backup.md
- Upgrade:
- Upgrade node: HowTo/Upgrade/Upgrade-Node.md
- Upgrade protocol: HowTo/Upgrade/Upgrade-Protocol.md
- Prepare for The Merge: HowTo/Upgrade/Prepare-for-The-Merge.md
- Develop dapps on Besu:
- Use Truffle: HowTo/Develop-Dapps/Truffle.md
- Use client libraries: HowTo/Develop-Dapps/Client-Libraries.md
- Troubleshoot:
- Add and remove validators without voting: HowTo/Troubleshoot/Add-Validators-Without-Voting.md
- Use EVM tool: HowTo/Troubleshoot/Use-EVM-Tool.md
- Collect Java runtime data: HowTo/Troubleshoot/Java-Flight-Recording.md
- Trace transactions: HowTo/Troubleshoot/Trace-Transactions.md
- Solve common problems: HowTo/Troubleshoot/Troubleshooting.md
- Tutorials:
- Quorum Developer Quickstart: Tutorials/Developer-Quickstart.md
- Create a private network:
- Use QBFT (PoA): Tutorials/Private-Network/Create-QBFT-Network.md
- Use IBFT 2.0 (PoA): Tutorials/Private-Network/Create-IBFT-Network.md
- Use Clique (PoA): Tutorials/Private-Network/Create-Private-Clique-Network.md
- Use Ethash (PoW): Tutorials/Private-Network/Create-Private-Network.md
- Add and remove IBFT 2.0 validators: Tutorials/Private-Network/Adding-removing-IBFT-validators.md
- Permissioning:
- Create a permissioned network: Tutorials/Permissioning/Create-Permissioned-Network.md
- Get started with onchain permissioning: Tutorials/Permissioning/Getting-Started-Onchain-Permissioning.md
- Upgrade the permissioning contracts: Tutorials/Permissioning/Upgrade-Permissioning-Contract.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
- Privacy:
- Create a privacy-enabled network: Tutorials/Privacy/Configuring-Privacy.md
- Create a privacy-enabled network using the Quickstart: Tutorials/Privacy/Privacy-Example.md
- Configure a multi-tenant network: Tutorials/Privacy/Configuring-Multi-Tenancy.md
- Use web3js-quorum multinode example: Tutorials/Privacy/web3js-quorum-Multinode-example.md
- Kubernetes:
- Overview: Tutorials/Kubernetes/Overview.md
- Local playground: Tutorials/Kubernetes/Playground.md
- Create a cluster: Tutorials/Kubernetes/Create-Cluster.md
- Deploy charts: Tutorials/Kubernetes/Deploy-Charts.md
- Quorum Explorer: Tutorials/Kubernetes/Quorum-Explorer.md
- Maintenance: Tutorials/Kubernetes/Maintenance.md
- Production: Tutorials/Kubernetes/Production.md
- Configure Kubernetes mode in NAT Manager: Tutorials/Kubernetes/Nat-Manager-Kubernetes.md
- Deploy on Microsoft Azure: Tutorials/Private-Network-Example-Azure.md
- Run Besu and Teku on the Merge testnet: Tutorials/Merge-Testnet.md
- Concepts:
- Architecture: Concepts/ArchitectureOverview.md
- Consensus protocols:
- Overview: Concepts/Consensus-Protocols/Overview-Consensus.md
- Comparing PoA consensus protocols: Concepts/Consensus-Protocols/Comparing-PoA.md
- Data storage formats: Concepts/Data-Storage-Formats.md
- Events and logs: Concepts/Events-and-Logs.md
- The Merge: Concepts/Merge.md
- Mining: Concepts/Mining.md
- Monitoring: Concepts/Monitoring.md
- Network ID and chain ID: Concepts/NetworkID-And-ChainID.md
- Network vs node configuration: Concepts/Network-vs-Node.md
- Node keys: Concepts/Node-Keys.md
- Node types: Concepts/Node-Types.md
- Permissioning:
- Overview: Concepts/Permissioning/Permissioning-Overview.md
- Onchain permissioning: Concepts/Permissioning/Onchain-Permissioning.md
- Permissioning plugin: Concepts/Permissioning/Plugin-Permissioning.md
- Plugins: Concepts/Plugins.md
- Privacy:
- Overview: Concepts/Privacy/Privacy-Overview.md
- Private transactions: Concepts/Privacy/Private-Transactions.md
- Privacy groups: Concepts/Privacy/Privacy-Groups.md
- Processing private transactions: Concepts/Privacy/Private-Transaction-Processing.md
- Flexible privacy groups: Concepts/Privacy/Flexible-PrivacyGroups.md
- Multi-tenancy: Concepts/Privacy/Multi-Tenancy.md
- Privacy plugin: Concepts/Privacy/Plugin-Privacy.md
- Protocol upgrades: Concepts/Protocol-Upgrades.md
- Pruning: Concepts/Pruning.md
- Public key infrastructure: Concepts/PKI.md
- TLS communication: Concepts/TLS.md
- Transactions:
- Transaction types: Concepts/Transactions/Transaction-Types.md
- Transaction pool: Concepts/Transactions/Transaction-Pool.md
- Validating transactions: Concepts/Transactions/Transaction-Validation.md
- Reference:
- Besu command line:
- Options: Reference/CLI/CLI-Syntax.md
- Subcommands: Reference/CLI/CLI-Subcommands.md
- Besu API methods: Reference/API-Methods.md
- Besu API objects: Reference/API-Objects.md
- Engine API methods: Reference/Engine-API-Methods.md
- Engine API objects: Reference/Engine-API-Objects.md
- Transaction trace types: Reference/Trace-Types.md
- Genesis file items: Reference/Config-Items.md
- Web3js-quorum reference: Reference/web3js-quorum.md
- Plugin API interfaces: Reference/Plugin-API-Interfaces.md
- Accounts for testing: Reference/Accounts-for-Testing.md
- EVM tool: Reference/Evm-Tool.md
- Projects using Besu: Reference/Projects-Using-Besu.md
- Security disclosure policy: Reference/Responsible-Disclosure.md
- Blog posts and webinars: Reference/Resources.md