This repository has been archived by the owner on Sep 16, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
mkdocs.yml
204 lines (198 loc) · 9.82 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
# Copyright 2018 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: Hyperledger Besu
site_url: https://besu.hyperledger.org/
site_description: Hyperledger Besu Java Ethereum client documentation.
site_author: Hyperledger Besu community
copyright: Hyperledger Besu and its documentation are licensed under Apache 2.0 license /
This <a href="https://readthedocs.org/">Readthedocs.org</a> documentation is maintained with love by <a href="https://pegasys.tech/">Hyperledger Besu community</a>.
#extra project info and template customisation
extra:
doc_site_edit_url: https://github.com/hyperledger/besu-docs/
versions:
stable: &stable_version 1.3.0
quickstart: *stable_version
latest_version_warning:
url_contains: /latest/
text: 'You are reading Hyperledger Besu 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:
chat: https://chat.hyperledger.org/channel/besu
email: besu@lists.hyperledger.org
website: https://www.hyperledger.org/projects/besu
issues: https://pegasys1.atlassian.net/secure/Dashboard.jspa?selectPageId=10000
google:
site_verification: 'TODO'
tag_manager: 'TODO'
search:
language: 'en'
tokenizer: '[\s]+'
logo_regular: logo.svg
logo_reversed: &logo_reversed logo-reversed.svg
# Repository
repo_name: hyperledger/besu
repo_url: https://github.com/hyperledger/besu/
theme:
name: material
custom_dir: docs/custom_theme
palette:
primary: blue-grey
accent: teal
favicon: favicon.ico
logo: *logo_reversed
nav:
- How To:
- Get Started with Besu:
- System Requirements: HowTo/Get-Started/System-Requirements.md
- Install Binary Distribution: HowTo/Get-Started/Install-Binaries.md
- Build from Source: HowTo/Get-Started/Build-From-Source.md
- Start Besu: HowTo/Get-Started/Starting-node.md
- Run Besu from Docker Image: HowTo/Get-Started/Run-Docker-Image.md
- Migrate from pre v1.2 Docker Image: HowTo/Get-Started/Migration-Docker.md
- Configure Besu:
- Consensus Protocols:
- Clique: HowTo/Configure/Consensus-Protocols/Clique.md
- IBFT 2.0: HowTo/Configure/Consensus-Protocols/IBFT.md
- Quorum IBFT 1.0 Network: HowTo/Configure/Consensus-Protocols/QuorumIBFT.md
- Specify Options in a Configuration File: HowTo/Configure/Using-Configuration-File.md
- Configure a Free Gas Network: HowTo/Configure/FreeGas.md
- Predeploy a Contract in the Genesis File: HowTo/Configure/Contracts-in-Genesis.md
- Configure Mining: HowTo/Configure/Mining.md
- Pass JVM Options: HowTo/Configure/Passing-JVM-Options.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
- Client Libraries:
- Use the web3.js-eea Client Library: HowTo/Interact/Client-Libraries/eeajs.md
- Filters:
- Access Logs Using JSON-RPC API: HowTo/Interact/Filters/Accessing-Logs-Using-JSON-RPC.md
- Find and Connect to Peers:
- Start a Bootnode: HowTo/Find-and-Connect/Bootnodes.md
- Configure Ports for Access: HowTo/Find-and-Connect/Configuring-Ports.md
- Manage Peers: HowTo/Find-and-Connect/Managing-Peers.md
- Use UPnP: HowTo/Find-and-Connect/Using-UPnP.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
- Include Revert Reason in Transaction Receipts: HowTo/Send-Transactions/Revert-Reason.md
- Limit Access to Node:
- Use Local Permissioning: HowTo/Limit-Access/Local-Permissioning.md
- Update Onchain Permissioning Whitelists: HowTo/Limit-Access/Updating-Whitelists.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
- Deploy for Production:
- Deploy to the Cloud: HowTo/Deploy/Cloud.md
- Use Ansible to Deploy Besu: HowTo/Deploy/Ansible.md
- Use Prometheus for Monitoring: HowTo/Deploy/Monitoring-Performance.md
- Configure High Availability of APIs: HowTo/Deploy/High-Availability.md
- Configure Bootnodes: HowTo/Deploy/Bootnodes.md
- Configure Validators: HowTo/Deploy/Validators.md
- Deploy Permissioning Management Dapp: HowTo/Deploy/Production.md
- Use Alethio Lite Explorer: HowTo/Deploy/Lite-Block-Explorer.md
- Use Alethio EthStats Lite Network Monitor: HowTo/Deploy/Lite-Network-Monitor.md
- Backup and Restore: HowTo/Backup/Backup.md
- Upgrade Network: HowTo/Upgrade/Upgrade-Network.md
- Develop Dapps on Besu:
- Use Truffle with Besu: HowTo/Develop-Dapps/Truffle.md
- Troubleshoot:
- Configure Logging: HowTo/Troubleshoot/Logging.md
- Solve Common Problems: HowTo/Troubleshoot/Troubleshooting.md
- Tutorials:
- Quickstarts:
- Private Network Quickstart: Tutorials/Quickstarts/Private-Network-Quickstart.md
- Private Network Quickstart for Private Transactions: Tutorials/Quickstarts/Privacy-Quickstart.md
- Private Network Quickstart On Azure: Tutorials/Quickstarts/Azure-Private-Network-Quickstart.md
- Create a Private Network:
- Using Ethash (Pow): Tutorials/Private-Network/Create-Private-Network.md
- Using Clique (PoA): Tutorials/Private-Network/Create-Private-Clique-Network.md
- Using IBFT 2.0 (PoA): Tutorials/Private-Network/Create-IBFT-Network.md
- Permissioning:
- Create a Permissioned Network: Tutorials/Permissioning/Create-Permissioned-Network.md
- Get Started with Onchain Permissioning: Tutorials/Permissioning/Getting-Started-Onchain-Permissioning.md
- Privacy:
- Create a Privacy-Enabled Network: Tutorials/Privacy/Configuring-Privacy.md
- Use web3.js-eea Multinode Example: Tutorials/Privacy/eeajs-Multinode-example.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
- Privacy:
- Overview: Concepts/Privacy/Privacy-Overview.md
- Privacy Groups: Concepts/Privacy/Privacy-Groups.md
- Processing Private Transactions: Concepts/Privacy/Private-Transaction-Processing.md
- Permissioning:
- Overview: Concepts/Permissioning/Permissioning-Overview.md
- Onchain Permissioning: Concepts/Permissioning/Onchain-Permissioning.md
- Transactions:
- Transaction Pool: Concepts/Transactions/Transaction-Pool.md
- Vadidating Transactions: Concepts/Transactions/Transaction-Validation.md
- Events and Logs: Concepts/Events-and-Logs.md
- Network vs Node Configuration: Concepts/Network-vs-Node.md
- Network ID and Chain ID: Concepts/NetworkID-And-ChainID.md
- Node Keys: Concepts/Node-Keys.md
- Alethio: Concepts/AlethioOverview.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
- Configuration Items in Genesis File: Reference/Config-Items.md
- web3.js-eaa Methods: Reference/web3js-eea-Methods.md
- Accounts for Testing: Reference/Accounts-for-Testing.md
- Security Disclosure Policy: Reference/Responsible-Disclosure.md
- Blog Posts and Webinars: Reference/Resources.md
markdown_extensions:
- toc:
permalink:
toc_depth: 3
- codehilite
- 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.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- meta
- smarty
plugins:
- search
- markdownextradata
- exclude:
glob:
- development/*
- community/*
- global/*