|
|
# 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/
|
|
|
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://jira.hyperledger.org/projects/BESU/issues
|
|
|
google:
|
|
|
site_verification: 'sGzYdFR_AYDRtsC-SNxMRwjellnfTgs5ZA0q7GIM5j0'
|
|
|
tag_manager: 'GTM-TS3WLJM'
|
|
|
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
|
|
|
- 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
|
|
|
- Create Besu 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
|
|
|
- Configure TLS: HowTo/Configure/Configure-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
|
|
|
- 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 web3js-eea Client Library: HowTo/Interact/Client-Libraries/web3js-eea.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
|
|
|
- Configure Logging: HowTo/Monitor/Logging.md
|
|
|
- Use Elastic Stack: HowTo/Monitor/Elastic-Stack.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
|
|
|
- Run Orion with Besu: HowTo/Use-Privacy/Run-Orion-With-Besu.md
|
|
|
- Use Onchain Privacy: HowTo/Use-Privacy/Use-OnChainPrivacy.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 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:
|
|
|
- Upgrade Node: HowTo/Upgrade/Upgrade-Node.md
|
|
|
- Upgrade Protocol: HowTo/Upgrade/Upgrade-Protocol.md
|
|
|
- Develop Dapps on Besu:
|
|
|
- Use Truffle with Besu: HowTo/Develop-Dapps/Truffle.md
|
|
|
- Use Web3.js to Sign Transactions: HowTo/Develop-Dapps/Use-web3js.md
|
|
|
- Troubleshoot:
|
|
|
- Trace Transactions: HowTo/Troubleshoot/Trace-Transactions.md
|
|
|
- Solve Common Problems: HowTo/Troubleshoot/Troubleshooting.md
|
|
|
- Tutorials:
|
|
|
- Examples:
|
|
|
- Private Network Example: Tutorials/Examples/Private-Network-Example.md
|
|
|
- Private Network Example for Private Transactions: Tutorials/Examples/Privacy-Example.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
|
|
|
- Configure a Multi-Tenant Network: Tutorials/Privacy/Configuring-Multi-Tenancy.md
|
|
|
- Use web3js-eea Multinode Example: Tutorials/Privacy/web3js-eea-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
|
|
|
- Client Libraries: Concepts/Client-Libraries.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
|
|
|
- Onchain Privacy Groups: Concepts/Privacy/Onchain-PrivacyGroups.md
|
|
|
- Multi-Tenancy: Concepts/Privacy/Multi-Tenancy.md
|
|
|
- Permissioning:
|
|
|
- Overview: Concepts/Permissioning/Permissioning-Overview.md
|
|
|
- Onchain Permissioning: Concepts/Permissioning/Onchain-Permissioning.md
|
|
|
- Protocol Upgrades: Concepts/Protocol-Upgrades.md
|
|
|
- Pruning: Concepts/Pruning.md
|
|
|
- Transactions:
|
|
|
- Transaction Pool: Concepts/Transactions/Transaction-Pool.md
|
|
|
- Validating Transactions: Concepts/Transactions/Transaction-Validation.md
|
|
|
- Monitoring: Concepts/Monitoring.md
|
|
|
- Events and Logs: Concepts/Events-and-Logs.md
|
|
|
- TLS Communication: Concepts/TLS.md
|
|
|
- Node Keys: Concepts/Node-Keys.md
|
|
|
- Network vs Node Configuration: Concepts/Network-vs-Node.md
|
|
|
- Network ID and Chain ID: Concepts/NetworkID-And-ChainID.md
|
|
|
- Mining: Concepts/Mining.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
|
|
|
- Transaction Trace Types: Reference/Trace-Types.md
|
|
|
- Genesis File Items: Reference/Config-Items.md
|
|
|
- web3js-eaa Methods: Reference/web3js-eea-Methods.md
|
|
|
- Plugin API Interfaces: Reference/Plugin-API-Interfaces.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:
|
|
|
- global/*
|
|
|
- git-revision-date
|
|
|
- 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://...)
|
|
|
HowTo/Deploy/High-Availability.md: HowTo/Configure/Configure-HA/High-Availability.md
|
|
|
HowTo/Deploy/Monitoring-Performance.md: HowTo/Monitor/Metrics.md
|
|
|
HowTo/Upgrade/Upgrade-Network.md: HowTo/Upgrade/Upgrade-Node.md
|
|
|
HowTo/Find-and-Connect/Using-UPnP.md: HowTo/Find-and-Connect/Specifying-NAT.md
|
|
|
Concepts/Transactions/Trace-Types.md: Reference/Trace-Types.md
|
|
|
|