Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/HowTo/Develop-Dapps/Use-web3js.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Hyperledger Besu client libraries
# Create a Signed Transaction using Web3.js

You can use the example Javascript scripts to create and send raw transactions in the private network
created by the [Private Network Quickstart](../../Tutorials/Quickstarts/Private-Network-Quickstart.md).
created by the [Private Network Example](../../Tutorials/Examples/Private-Network-Example.md).

Update the `JSON-RPC endpoint` in the following examples to the endpoint for the private
network displayed after running the `./run.sh` script.
Expand Down Expand Up @@ -105,4 +105,4 @@ A signed raw transaction string is displayed.
You can send the raw transaction yourself or let the script send it using the web3.js library.

If sending it yourself, the cURL command is displayed and can be copied and pasted. Otherwise, the script sends it and
the transaction receipt is displayed.
the transaction receipt is displayed.
2 changes: 1 addition & 1 deletion docs/HowTo/Get-Started/Run-Docker-Image.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Use this Docker image to run a single Besu node without installing Besu.
!!! important
The Docker image does not run on Windows.

## Quickstart
## Default Node for Mainnet

To run a Besu node in a container connected to the Ethereum mainnet:

Expand Down
12 changes: 6 additions & 6 deletions docs/HowTo/Monitor/Elastic-Stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,25 @@ description: Using Elastick Stack (ELK) with Hyperledger Besu

Elastic Stack (also known as ELK) is a common open-source log management platform.

The [Besu Quickstart](https://github.com/PegaSysEng/besu-quickstart) provides an example implementation
The [Besu Sample Networks](https://github.com/PegaSysEng/besu-sample-networks) provides example implementations
using Elastic Stack for log management.

The [Filebeat configuration](https://github.com/PegaSysEng/besu-quickstart/blob/master/filebeat/filebeat.yml)
The [Filebeat configuration](https://github.com/PegaSysEng/besu-sample-networks/blob/master/filebeat/filebeat.yml)
ingests the logs and outputs them to Redis for storage. Redis provides a highly available mechanism that
enables logs to be stored by any of the Elastic Beats and pulled by Logstash as required.

The [pipeline configuration](https://github.com/PegaSysEng/besu-quickstart/blob/master/logstash/pipeline/20_besu.conf)
The [pipeline configuration](https://github.com/PegaSysEng/besu-sample-networks/blob/master/logstash/pipeline/20_besu.conf)
defines the json format used for Besu logs and automatically picks up any new log fields.

!!! note
The pipeline configuration must match the your log format. If using the default, you can use the
[grok plugin](https://www.elastic.co/guide/en/logstash/current/plugins-filters-grok.html) to
extract the log fields.

To see the Besu Quickstart logs in Kibana:
To see the Besu Sample Networks logs in Kibana:

1. [Start the Besu Quickstart](../../Tutorials/Quickstarts/Private-Network-Quickstart.md).
1. Open the [`Kibana logs address`](http://localhost:5601/app/kibana#/discover) listed by the Besu Quickstart.
1. [Start the Besu Private Network Example](../../Tutorials/Examples/Private-Network-Example.md), adding the `-e` parameter to the `run.sh` command.
1. Open the [`Kibana logs address`](http://localhost:5601/app/kibana#/discover) listed by the sample networks `list.sh` script.
The logs are displayed in Kibana.

![Kibana](../../images/KibanaQuickstart.png)
Expand Down
6 changes: 3 additions & 3 deletions docs/HowTo/Monitor/Logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Hyperledger Besu uses Log4J2 for logging. There are two methods to configure log
* [Basic](#basic-log-level-setting) - changes the log level.
* [Advanced](#advanced-custom-logging) - configures the output and format of the logs.

The Besu Quickstart provides an [example implementation using Elastic Stack](Elastic-Stack.md) (also
The Besu Sample Networks provides an [example implementation using Elastic Stack](Elastic-Stack.md) (also
known as ELK) for log management.

## Basic log level setting
Expand Down Expand Up @@ -70,5 +70,5 @@ setting it before starting Besu.

### Log rotation

The [Besu Quickstart](https://github.com/PegaSysEng/besu-quickstart) logging configuration defines a
[log rotation to restrict the size of the log files](https://github.com/PegaSysEng/besu-quickstart/blob/master/config/besu/log-config.xml).
The [Besu Sample Networks](https://github.com/PegaSysEng/besu-sample-networks) logging configuration defines a
[log rotation to restrict the size of the log files](https://github.com/PegaSysEng/besu-sample-networks/blob/master/config/besu/log-config.xml).
4 changes: 2 additions & 2 deletions docs/HowTo/Monitor/Metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Use the [`--metrics-enabled`](../../Reference/CLI/CLI-Syntax.md#metrics-enabled)
alerting service to access Besu metrics. Use [Grafana](https://grafana.com/) to visualize the collected data.
A sample [Besu Grafana dashboard](https://grafana.com/dashboards/10273) is provided.

The Besu Quickstart has [monitoring with Prometheus and Grafana configured](../../Tutorials/Quickstarts/Private-Network-Quickstart.md#monitoring-nodes-with-prometheus-and-grafana).
The Besu Example Networks have [monitoring with Prometheus and Grafana configured](../../Tutorials/Examples/Private-Network-Example.md#monitoring-nodes-with-prometheus-and-grafana).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we using Besu Sample Networks (see Log rotation section above) and Besu Example Networks interchangebly? Suggest standardising on one (Sample Networks probably) if possible.


!!! example
Use Prometheus to monitor the number of blocks your Besu node is behind the chain head and be alerted
Expand Down Expand Up @@ -141,4 +141,4 @@ To configure Prometheus and run with Besu pushing to a push gateway:
established.

Click the **Graph** tab to view the data as a time-based graph. The query string is displayed below the graph.
For example: `{ethereum_blockchain_height{instance="localhost:9545",job="prometheus"}`
For example: `{ethereum_blockchain_height{instance="localhost:9545",job="prometheus"}`
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
description: Hyperledger Besu private network with privacy enabled quickstart tutorial
description: Hyperledger Besu private network with privacy enabled tutorial
<!--- END of page meta data -->

# Private Network with Privacy Enabled Quickstart Tutorial
# Privacy-enabled Private Network Example Tutorial

The Private Network with Privacy Enabled Quickstart runs a private network of Hyperledger Besu and
The Private Network with Privacy Enabled Example runs a private network of Hyperledger Besu and
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again, "Privacy-enabled"

Orion nodes managed by Docker Compose.
It is an expanded version of the [Private Network Quickstart](Private-Network-Quickstart.md).
It is an expanded version of the [Private Network Example](Private-Network-Example.md).

You can use the [Block Explorer](Private-Network-Quickstart.md#block-explorer),
make [JSON-RPC requests](Private-Network-Quickstart.md#run-json-rpc-requests), and
create [transactions using Metamask](Private-Network-Quickstart.md#creating-a-transaction-using-metamask)
as described in the [Private Network Quickstart tutorial](Private-Network-Quickstart.md).
You can use the [Block Explorer](Private-Network-Example.md#block-explorer),
make [JSON-RPC requests](Private-Network-Example.md#run-json-rpc-requests), and
create [transactions using Metamask](Private-Network-Example.md#creating-a-transaction-using-metamask)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

comma at the end of the line, to separate from "as described in..."

as described in the [Private Network Example tutorial](Private-Network-Example.md).
This tutorial describes how to use the examples provided in the EEAJS library to [create and send private transactions](#send-private-transactions-and-read-values).

!!! important
The quickstart runs a private network suitable for education or demonstration purposes.
The quickstart is not intended for running production networks.
The sample-network runs a private network suitable for education or demonstration purposes.
The sample-network is not intended for running production networks.

## Prerequisites

Expand All @@ -32,16 +32,16 @@ To run this tutorial, you must have the following installed:

- [Curl command line](https://curl.haxx.se/download.html)

## Clone Besu Quickstart Source Code
## Clone Besu Sample Networks Source Code

Clone the repository from the `besu-quickstart` repository.
Clone the repository from the `besu-` repository.

```bash tab="Linux/MacOS"
git clone https://github.com/PegaSysEng/besu-quickstart.git
git clone https://github.com/PegaSysEng/besu-sample-networks.git
```

!!!note
Download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases.
To use a specific version of Hyperledger Besu, set the `BESU_VERSION` environment variable.

## Clone EEAJS Libraries

Expand All @@ -57,12 +57,12 @@ In the `eeajs` directory:
npm install
```

## Start the Private Network with Privacy Enabled
## Start the Network

!!!important
If running in Windows, please run commands from the GitBash shell

In the `besu-quickstart` directory, start the network with privacy enabled:
In the `besu-sample-networks` directory, start the network with privacy enabled:

```bash
./run-privacy.sh
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
description: Hyperledger Besu private network quickstart tutorial
description: Hyperledger Besu private network tutorial
<!--- END of page meta data -->

# Private Network Quickstart Tutorial
# Private Network Example Tutorial

The Private Network Quickstart uses the Hyperledger Besu Docker image to run a private network of
The Private Network Example uses the Hyperledger Besu Docker image to run a private network of
Besu nodes managed by Docker Compose.

!!! important
The Private Network Quickstart runs a private network suitable for education or demonstration purposes.
The Private Network Quickstart is not intended for running production networks.
The Private Network Example runs a private network suitable for education or demonstration purposes.
The Private Network Example is not intended for running production networks.

## Prerequisites

Expand All @@ -27,24 +27,24 @@ To run this tutorial, you must have the following installed:
the MetaMask plug-in installed. This tutorial uses screenshots from Brave.


## Clone Besu Quickstart Source Code
## Clone Besu Sample Networks Source Code

Clone the repository from the `besu-quickstart` repository:
Clone the repository from the `besu-sample-networks` repository:

```bash tab="Linux/MacOS"
git clone https://github.com/PegaSysEng/besu-quickstart.git
git clone https://github.com/PegaSysEng/besu-sample-networks.git
```

!!!note
Download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases.
To use a specific version of Hyperledger Besu, set the `BESU_VERSION` environment variable.

## Start Services and Network
## Start the Network

!!!important
If running in Windows, please run commands from the GitBash shell

This tutorial uses [Docker Compose](https://docs.docker.com/compose/) to assemble the images and
run the private network. To build the docker images and run the containers, go to the `besu-quickstart` directory and run:
run the private network. To build the docker images and run the containers, go to the `besu-sample-networks` directory and run:

```bash tab="Linux/MacOS"
./run.sh
Expand All @@ -58,24 +58,24 @@ When the process ends, it lists the running services:
!!! example "Docker-compose services list example"
```log
*************************************
Besu Quickstart latest
Sample Network for Besu at latest
*************************************
List endpoints and services
----------------------------------
Name Command State Ports
-----------------------------------------------------------------------------------------------------------------------------------------------------------
besu-quickstart_bootnode_1 /opt/besu/bootnode_start.s ... Up 0.0.0.0:30303->30303/tcp, 0.0.0.0:30303->30303/udp, 8545/tcp, 8546/tcp, 8547/tcp
besu-quickstart_elasticsearch_1 /usr/local/bin/docker-entr ... Up 9200/tcp, 9300/tcp
besu-quickstart_explorer_1 nginx -g daemon off; Up 0.0.0.0:25000->80/tcp
besu-quickstart_filebeat_1 /usr/local/bin/docker-entr ... Up
besu-quickstart_grafana_1 /run.sh Up 0.0.0.0:3000->3000/tcp
besu-quickstart_kibana_1 /usr/local/bin/dumb-init - ... Up 0.0.0.0:5601->5601/tcp
besu-quickstart_logstash_1 /usr/local/bin/docker-entr ... Up 5044/tcp, 9600/tcp
besu-quickstart_minernode_1 /opt/besu/node_start.sh -- ... Up 30303/tcp, 8545/tcp, 8546/tcp, 8547/tcp
besu-quickstart_node_1 /opt/besu/node_start.sh -- ... Up 30303/tcp, 8545/tcp, 8546/tcp, 8547/tcp
besu-quickstart_prometheus_1 /bin/prometheus --config.f ... Up 0.0.0.0:9090->9090/tcp
besu-quickstart_redis_1 docker-entrypoint.sh redis ... Up 6379/tcp
besu-quickstart_rpcnode_1 /opt/besu/node_start.sh -- ... Up 30303/tcp, 0.0.0.0:8545->8545/tcp, 8546/tcp, 8547/tcp
besu-sample-network_bootnode_1 /opt/besu/bootnode_start.s ... Up 0.0.0.0:30303->30303/tcp, 0.0.0.0:30303->30303/udp, 8545/tcp, 8546/tcp, 8547/tcp
besu-sample-network_elasticsearch_1 /usr/local/bin/docker-entr ... Up 9200/tcp, 9300/tcp
besu-sample-network_explorer_1 nginx -g daemon off; Up 0.0.0.0:25000->80/tcp
besu-sample-network_filebeat_1 /usr/local/bin/docker-entr ... Up
besu-sample-network_grafana_1 /run.sh Up 0.0.0.0:3000->3000/tcp
besu-sample-network_kibana_1 /usr/local/bin/dumb-init - ... Up 0.0.0.0:5601->5601/tcp
besu-sample-network_logstash_1 /usr/local/bin/docker-entr ... Up 5044/tcp, 9600/tcp
besu-sample-network_minernode_1 /opt/besu/node_start.sh -- ... Up 30303/tcp, 8545/tcp, 8546/tcp, 8547/tcp
besu-sample-network_node_1 /opt/besu/node_start.sh -- ... Up 30303/tcp, 8545/tcp, 8546/tcp, 8547/tcp
besu-sample-network_prometheus_1 /bin/prometheus --config.f ... Up 0.0.0.0:9090->9090/tcp
besu-sample-network_redis_1 docker-entrypoint.sh redis ... Up 6379/tcp
besu-sample-network_rpcnode_1 /opt/besu/node_start.sh -- ... Up 30303/tcp, 0.0.0.0:8545->8545/tcp, 8546/tcp, 8547/tcp
Setting up the besu index pattern in kibana
{"type":"index-pattern","id":"besu","attributes":{"title":"besu-*","timeFieldName":"@timestamp"},"references":[],"migrationVersion":{"index-pattern":"6.5.0"},"updated_at":"2019-12-27T04:41:07.665Z","version":"WzMsMV0="}
Orion not running, skipping the orion index pattern in kibana.
Expand Down Expand Up @@ -140,7 +140,7 @@ You can search for a specific block, transaction hash, or address by clicking th

## Monitoring nodes with Prometheus and Grafana

The quickstart also includes Prometheus and Grafana monitoring tools to let you visualise the nodes
The sample network also includes Prometheus and Grafana monitoring tools to let you visualise the nodes
health and usage. You can directly access these tools from your browser at the addresses displayed
in the endpoint list.

Expand Down Expand Up @@ -455,7 +455,7 @@ To restart the private network:

## Stop Private Network and Remove Containers

To shut down the private network and delete all containers and images created during the quickstart:
To shut down the private network and delete all containers and images created from running the sample network:

```bash tab="Linux/MacOS"
./remove.sh
Expand Down
4 changes: 2 additions & 2 deletions docs/Tutorials/Permissioning/Create-Permissioned-Network.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ The result confirms Node-1 (the node running the JSON-RPC service) has two peers

#### Send a Transaction from an Account in the Whitelist

Import the first account from the genesis file into MetaMask and send transactions as described in the [Private Network Quickstart Tutorial](../Quickstarts/Private-Network-Quickstart.md#creating-a-transaction-using-metamask):
Import the first account from the genesis file into MetaMask and send transactions as described in the [Private Network Example Tutorial](../Examples/Private-Network-Example.md#creating-a-transaction-using-metamask):

!!! example "Account 1"
* Address: `0xfe3b557e8fb62b89f4916b721be55ceb828dbd73`
Expand All @@ -300,7 +300,7 @@ Import the first account from the genesis file into MetaMask and send transactio

### Try Sending a Transaction from an Account Not in the Accounts Whitelist

Import the last account from the genesis file into MetaMask and try to send a transactions as described in the [Private Network Quickstart Tutorial](../Quickstarts/Private-Network-Quickstart.md#creating-a-transaction-using-metamask):
Import the last account from the genesis file into MetaMask and try to send a transactions as described in the [Private Network Example Tutorial](../Examples/Private-Network-Example.md#creating-a-transaction-using-metamask):

!!! example "Account 3"
* Address: `0xf17f52151EbEF6C7334FAD080c5704D77216b732`
Expand Down
2 changes: 1 addition & 1 deletion docs/Tutorials/Private-Network/Create-IBFT-Network.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ Use the [IBFT API](../../Reference/API-Methods.md#ibft-20-methods) to remove or

This tutorial configures a private network using IBFT 2.0 for educational purposes only. IBFT 2.0 requires 4 validators to be Byzantine fault tolerant.

Import accounts to MetaMask and send transactions as described in the [Private Network Quickstart Tutorial](../Quickstarts/Private-Network-Quickstart.md#creating-a-transaction-using-metamask)
Import accounts to MetaMask and send transactions as described in the [Private Network Example Tutorial](../Examples/Private-Network-Example.md#creating-a-transaction-using-metamask)

!!! info
Besu does not implement [private key management](../../HowTo/Send-Transactions/Account-Management.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ Use the [Clique API to add](../../HowTo/Configure/Consensus-Protocols/Clique.md#
!!! note
To add Node-2 or Node-3 as a signer you need the [node address as when specifying Node-1](#2-get-address-for-node-1) as the initial signer.

Import accounts to MetaMask and send transactions as described in the [Private Network Quickstart Tutorial](../Quickstarts/Private-Network-Quickstart.md#creating-a-transaction-using-metamask)
Import accounts to MetaMask and send transactions as described in the [Private Network Example Tutorial](../Examples/Private-Network-Example.md#creating-a-transaction-using-metamask)

!!! info
Besu does not implement [private key management](../../HowTo/Send-Transactions/Account-Management.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/Tutorials/Private-Network/Create-Private-Network.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ The result confirms Node-1 (the node running the JSON-RPC service) has two peers

## Next Steps

Import accounts to MetaMask and send transactions as described in the [Private Network Quickstart Tutorial](../Quickstarts/Private-Network-Quickstart.md#creating-a-transaction-using-metamask)
Import accounts to MetaMask and send transactions as described in the [Private Network Example Tutorial](../Examples/Private-Network-Example.md#creating-a-transaction-using-metamask)

!!! info
Besu does not implement [private key management](../../HowTo/Send-Transactions/Account-Management.md).
Expand Down
Loading