status-im
/
nimbus-eth1
mirror of https://github.com/status-im/nimbus-eth1.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add Docker quickstart page for Fluffy + minor docs fixes (#2744)

This commit is contained in:
Kim De Mey 2024-10-16 14:56:52 +02:00 committed by GitHub
parent b885f822d0
commit 4191f95527
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 32 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
fluffy/docs/the_fluffy_book/docs/index.md
View File

@ -16,6 +16,7 @@ To quickly get your Fluffy node up and running, follow the quickstart page:
- [Quickstart for Linux / macOS users](./quick-start.md) - [Quickstart for Linux / macOS users](./quick-start.md)
- [Quickstart for Windows users](./quick-start-windows.md) - [Quickstart for Windows users](./quick-start-windows.md)
- [Quickstart for Docker users](./quick-start-docker.md)
# Development status # Development status
The Portal Network is a project still in research phase. The Portal Network is a project still in research phase.

2
fluffy/docs/the_fluffy_book/docs/metrics.md
View File

@ -26,7 +26,7 @@ explained in [this guide](https://nimbus.guide/metrics-pretty-pictures.html#prom
A Fluffy specific dashboard can be found [here](https://github.com/status-im/nimbus-eth1/blob/master/fluffy/grafana/fluffy_grafana_dashboard.json). A Fluffy specific dashboard can be found [here](https://github.com/status-im/nimbus-eth1/blob/master/fluffy/grafana/fluffy_grafana_dashboard.json).
This is the dashboard used for our Fluffy testnet fleet. This is the dashboard used for our Fluffy Portal network fleet.
In order to use it locally, you will have to remove the In order to use it locally, you will have to remove the
`{job="nimbus-fluffy-metrics"}` part from the `instance` and `container` `{job="nimbus-fluffy-metrics"}` part from the `instance` and `container`
variables queries in the dashboard settings. Or they can also be changed to a variables queries in the dashboard settings. Or they can also be changed to a

26
fluffy/docs/the_fluffy_book/docs/quick-start-docker.md
View File

@ -3,8 +3,30 @@
This page takes you through the steps of getting the Fluffy Portal node running This page takes you through the steps of getting the Fluffy Portal node running
on the public network by use of the [public Docker image](https://hub.docker.com/r/statusim/nimbus-fluffy/tags). on the public network by use of the [public Docker image](https://hub.docker.com/r/statusim/nimbus-fluffy/tags).
The docker image gets currently rebuild from latest master every night. The Docker image gets rebuild from latest master every night and only `amd64` is supported currently.
## Steps ## Steps
To be added. ### Prerequisites
- [Docker](https://www.docker.com/)
### Use the Docker image to run a Fluffy client on the Portal network
```bash
# Connect to the Portal bootstrap nodes and enable the JSON-RPC APIs.
docker container run -p 8545:8545 statusim/nimbus-fluffy:amd64-master-latest --rpc --rpc-address:0.0.0.0
```
!!! note
Port 8545 is published and `rpc-address` is set to the `ANY` address in this command to allow access to the JSON-RPC API from outside the Docker image. You might want to adjust that depending on the use case & security model.
It is also recommended to use a mounted volume for Fluffy's `--data-dir` in case of a long-running container.
### Try requesting an execution layer block from the network
Requesting history content on the Portal network can be easily tested by using the `eth_getBlockByHash` JSON-RPC from the [execution JSON-RPC API](https://ethereum.github.io/execution-apis/api-documentation/).
```bash
# Get the hash of a block from your favorite block explorer, e.g.:
BLOCKHASH=0x55b11b918355b1ef9c5db810302ebad0bf2544255b530cdce90674d5887bb286 # Replace this to the block hash of your choice
# Run this command to get the block:
curl -s -X POST -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0","id":"1","method":"eth_getBlockByHash","params":["'${BLOCKHASH}'", true]}' http://localhost:8545
```

6
fluffy/docs/the_fluffy_book/docs/quick-start-windows.md
View File

@ -29,14 +29,14 @@ mingw32-make fluffy
./build/fluffy --help ./build/fluffy --help
``` ```
### Run a Fluffy client on the public testnet ### Run a Fluffy client on the Portal network
```bash ```bash
# Connect to the Portal testnet bootstrap nodes and enable the JSON-RPC APIs # Connect to the Portal bootstrap nodes and enable the JSON-RPC APIs
./build/fluffy --rpc ./build/fluffy --rpc
``` ```
### Try requesting a execution layer block from the network ### Try requesting an execution layer block from the network
Requesting history content on the Portal network can be easily tested by using the `eth_getBlockByHash` JSON-RPC from the [execution JSON-RPC API](https://ethereum.github.io/execution-apis/api-documentation/). Requesting history content on the Portal network can be easily tested by using the `eth_getBlockByHash` JSON-RPC from the [execution JSON-RPC API](https://ethereum.github.io/execution-apis/api-documentation/).

6
fluffy/docs/the_fluffy_book/docs/quick-start.md
View File

@ -24,14 +24,14 @@ make fluffy
./build/fluffy --help ./build/fluffy --help
``` ```
### Run a Fluffy client on the public testnet ### Run a Fluffy client on the Portal network
```bash ```bash
# Connect to the Portal testnet bootstrap nodes and enable the JSON-RPC APIs # Connect to the Portal bootstrap nodes and enable the JSON-RPC APIs
./build/fluffy --rpc ./build/fluffy --rpc
``` ```
### Try requesting a execution layer block from the network ### Try requesting an execution layer block from the network
Requesting history content on the Portal network can be easily tested by using the `eth_getBlockByHash` JSON-RPC from the [execution JSON-RPC API](https://ethereum.github.io/execution-apis/api-documentation/). Requesting history content on the Portal network can be easily tested by using the `eth_getBlockByHash` JSON-RPC from the [execution JSON-RPC API](https://ethereum.github.io/execution-apis/api-documentation/).