|
|
# 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://wiki.hyperledger.org/display/besu">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://discord.gg/hyperledger
|
|
|
email: besu@lists.hyperledger.org
|
|
|
website: https://www.hyperledger.org/projects/besu
|
|
|
issues: https://github.com/hyperledger/besu/issues
|
|
|
doc_issues: https://github.com/hyperledger/besu-docs/issues/new/choose
|
|
|
google:
|
|
|
site_verification:
|
|
|
- 'sGzYdFR_AYDRtsC-SNxMRwjellnfTgs5ZA0q7GIM5j0'
|
|
|
tag_manager: 'GTM-TS3WLJM'
|
|
|
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: custom_theme
|
|
|
palette:
|
|
|
primary: blue-grey
|
|
|
accent: teal
|
|
|
favicon: favicon.svg
|
|
|
logo: *logo_reversed
|
|
|
|
|
|
extra_css:
|
|
|
- assets/stylesheets/custom_theme.css
|
|
|
- assets/stylesheets/zoomify.min.css
|
|
|
extra_javascript:
|
|
|
- assets/javascripts/custom_theme.js
|
|
|
- assets/javascripts/zoomify.min.js
|
|
|
|
|
|
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
|
|
|
- Configure Besu:
|
|
|
- Consensus protocols:
|
|
|
- IBFT 2.0: HowTo/Configure/Consensus-Protocols/IBFT.md
|
|
|
- QBFT: HowTo/Configure/Consensus-Protocols/QBFT.md
|
|
|
- Clique: HowTo/Configure/Consensus-Protocols/Clique.md
|
|
|
- Add and remove validators: HowTo/Configure/Consensus-Protocols/Add-Validators.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
|
|
|
- Configure the data storage format: HowTo/Configure/Configure-Data-Storage.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-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
|
|
|
- Develop dapps on Besu:
|
|
|
- Use Truffle: HowTo/Develop-Dapps/Truffle.md
|
|
|
- Use client libraries: HowTo/Develop-Dapps/Client-Libraries.md
|
|
|
- Troubleshoot:
|
|
|
- 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:
|
|
|
- Examples:
|
|
|
- Private network example: Tutorials/Examples/Private-Network-Example.md
|
|
|
- Private network example for private transactions: Tutorials/Examples/Privacy-Example.md
|
|
|
- Configure Kubernetes mode in NAT Manager : Tutorials/Examples/Nat-Manager-Kubernetes.md
|
|
|
- Deploy on Microsoft Azure: Tutorials/Examples/Private-Network-Example-Azure.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
|
|
|
- Using QBFT (PoA): Tutorials/Private-Network/Create-QBFT-Network.md
|
|
|
- Adding and removing 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
|
|
|
- Configure a multi-tenant network: Tutorials/Privacy/Configuring-Multi-Tenancy.md
|
|
|
- Use web3js-quorum multinode example: Tutorials/Privacy/web3js-quorum-Multinode-example.md
|
|
|
- Developer Quickstart: Tutorials/Developer-Quickstart.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
|
|
|
- Maintenance: Tutorials/Kubernetes/Maintenance.md
|
|
|
- Production: Tutorials/Kubernetes/Production.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
|
|
|
- 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
|
|
|
- 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
|
|
|
|
|
|
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
|
|
|
|
|
|
plugins:
|
|
|
- search:
|
|
|
lang: 'en'
|
|
|
separator: '[\s\-\.\_]+'
|
|
|
- markdownextradata
|
|
|
- exclude:
|
|
|
glob:
|
|
|
- global/*
|
|
|
- git-revision-date-localized:
|
|
|
locale: en
|
|
|
# - minify:
|
|
|
# minify_html: true
|
|
|
# minify_js: true
|
|
|
# htmlmin_opts:
|
|
|
# remove_comments: true
|
|
|
- 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/Get-Started/System-Requirements-Private.md: HowTo/Get-Started/System-Requirements/System-Requirements-Private.md
|
|
|
HowTo/Get-Started/System-Requirements-Public.md: HowTo/Get-Started/System-Requirements/System-Requirements-Public.md
|
|
|
HowTo/Get-Started/Install-Binaries.md: HowTo/Get-Started/Installation-Options/Install-Binaries.md
|
|
|
HowTo/Get-Started/Build-from-source.md: HowTo/Get-Started/Installation-Options/Build-from-source.md
|
|
|
HowTo/Get-Started/Run-Docker-Image.md: HowTo/Get-Started/Installation-Options/Run-Docker-Image.md
|
|
|
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
|
|
|
HowTo/Use-Privacy/Run-Orion-With-Besu.md: HowTo/Use-Privacy/Run-Tessera-With-Besu.md
|
|
|
Concepts/Transactions/Trace-Types.md: Reference/Trace-Types.md
|
|
|
HowTo/Develop-Dapps/Use-web3js.md: HowTo/Develop-Dapps/Client-Libraries.md
|
|
|
Concepts/Client-Libraries.md: HowTo/Develop-Dapps/Client-Libraries.md
|
|
|
Concepts/Privacy/Onchain-PrivacyGroups.md: Concepts/Privacy/Flexible-PrivacyGroups.md
|
|
|
HowTo/Use-Privacy/Use-OnChainPrivacy.md: HowTo/Use-Privacy/Use-FlexiblePrivacy.md
|
|
|
Tutorials/Quickstarts/Azure-Private-Network-Quickstart.md: Tutorials/Examples/Private-Network-Example-Azure.md
|
|
|
HowTo/Interact/Client-Libraries/eeajs.md: HowTo/Interact/Client-Libraries/web3js-quorum.md
|
|
|
HowTo/Interact/Client-Libraries/web3js-eea.md: HowTo/Interact/Client-Libraries/web3js-quorum.md
|
|
|
Privacy/Explanation/Privacy-Groups.md: Concepts/Privacy/Privacy-Groups.md
|
|
|
Tutorials/Privacy/eeajs-Multinode-example.md: Tutorials/Privacy/web3js-quorum-Multinode-example.md
|
|
|
Tutorials/Privacy/web3js-eea-Multinode-example.md: Tutorials/Privacy/web3js-quorum-Multinode-example.md
|
|
|
HowTo/Configure/Configure-TLS.md: HowTo/Configure/TLS/Configure-TLS.md
|
|
|
HowTo/Deploy/Lite-Block-Explorer.md: https://github.com/Alethio/ethereum-lite-explorer
|
|
|
HowTo/Deploy/Lite-Network-Monitor.md: https://github.com/Alethio/ethstats-network-dashboard
|
|
|
HowTo/Configure/Consensus-Protocols/QuorumIBFT.md: HowTo/Configure/Consensus-Protocols/QBFT.md
|
|
|
|
