diff --git a/docs/the_nimbus_book/src/SUMMARY.md b/docs/the_nimbus_book/src/SUMMARY.md index d68076334..18d4a989e 100644 --- a/docs/the_nimbus_book/src/SUMMARY.md +++ b/docs/the_nimbus_book/src/SUMMARY.md @@ -29,10 +29,10 @@ # Tutorials - [Grafana and Prometheus](./metrics-pretty-pictures.md) -- [Network stats + monitoring](./eth2-stats.md) - [Setup a systemd service](./beacon-node-systemd.md) - [Create your own Infura endpoint](./infura-guide.md) - [Switch between clients]() +- [Network stats (testnets only)](./eth2-stats.md) # Reference - [Advanced options]() diff --git a/docs/the_nimbus_book/src/beacon-node-systemd.md b/docs/the_nimbus_book/src/beacon-node-systemd.md index bb9a27869..12f9ec6ff 100644 --- a/docs/the_nimbus_book/src/beacon-node-systemd.md +++ b/docs/the_nimbus_book/src/beacon-node-systemd.md @@ -5,37 +5,29 @@ This page will take you through how to set up a `systemd` service for your beaco ## Prerequisites -NBC's [external dependencies](./install.md#external-dependencies) and a working [Go](https://golang.org/doc/install) installation (v1.11 or later). +NBC's [external dependencies](./install.md#external-dependencies). -### 1. Clone repositories +### 1. Clone repository -Clone the [nimbus-eth2](https://github.com/status-im/nimbus-eth2) and [eth2stats](https://github.com/Alethio/eth2stats-client) repositories in the same directory (so that both repositories are adjacent to each other). +If you haven't done so already, clone the [nimbus-eth2](https://github.com/status-im/nimbus-eth2) repository. ```console git clone https://github.com/status-im/nimbus-eth2.git -git clone https://github.com/Alethio/eth2stats-client.git ``` -### 2. Build repositories +### 2. Build repository -Build both repositories by following their respective build instructions. +Move into the directory and build the beacon node. -*nimbus-eth2* ```console cd nimbus-eth2 make nimbus_beacon_node ``` -*eth2stats* -```console -cd eth2stats-client -make build -``` +The resulting binaries should appear in `nimbus-eth2/build/nimbus_beacon_node`. -The resulting binaries should appear in `nimbus-eth2/build/nimbus_beacon_node` and `eth2stats-client/eth2stats-client`, respectively. - -### 3. Create a systemd service unit file for the Nimbus beacon node service +### 3. Create a systemd service unit file Create a `systemd` service unit file -- `nbc.service` -- and save it in `/etc/systemd/system/`. @@ -68,48 +60,16 @@ Replace: `` with the WebSocket JSON-RPC URL that you are planning to use. -### 4. Create a systemd service unit file for the Eth2Stats client -Create a `systemd` service unit file -- `eth2stata.service` -- and save it in `/etc/systemd/system/`. - -```txt -[Unit] -Description=Eth2Stats Client - -[Service] -ExecStart=/eth2stats-client run \ - --data.folder=/data \ - --eth2stats.node-name="" \ - --eth2stats.addr="grpc.pyrmont.eth2.wtf:8080" --eth2stats.tls=false \ - --beacon.type="nimbus" \ - --beacon.addr="http://localhost:9190" \ - --beacon.metrics-addr="http://localhost:8008/metrics" -User= -Group= -Restart=always - -[Install] -WantedBy=default.target -``` - -Replace: - -`` with the location of the repository in which you performed the `git clone` command in step 1. - -`` with the username of the system user responsible for running the launched processes. - -`` with the name of your node on [https://pyrmont.eth2.wtf/](https://pyrmont.eth2.wtf/). - -### 5. Notify systemd of the newly added services +### 4. Notify systemd of the newly added service ```console sudo systemctl daemon-reload ``` -### 6. Start the services +### 5. Start the service ```console sudo systemctl enable nbc --now -sudo systemctl enable eth2stats --now ``` diff --git a/docs/the_nimbus_book/src/eth2-stats.md b/docs/the_nimbus_book/src/eth2-stats.md index fa8715748..2b7ff55e9 100644 --- a/docs/the_nimbus_book/src/eth2-stats.md +++ b/docs/the_nimbus_book/src/eth2-stats.md @@ -1,6 +1,7 @@ # Network stats and monitoring -> ⚠️ This page concerns the [Pyrmont](https://pyrmont.launchpad.ethereum.org/) testnet. It will be updated for mainnet soon. +> ⚠️ This page concerns the [Pyrmont](https://pyrmont.launchpad.ethereum.org/) testnet. eth2stats is a debugging / developer tool that's suitable for testnets. For privacy reasons, we do not recommend using it for mainnet. For a mainnet alternative, see [this guide](./metrics-pretty-pictures.md). + eth2stats is a network monitoring suite for your beacon node + validator client. diff --git a/docs/the_nimbus_book/src/install.md b/docs/the_nimbus_book/src/install.md index 488eb270f..297f36f57 100644 --- a/docs/the_nimbus_book/src/install.md +++ b/docs/the_nimbus_book/src/install.md @@ -24,7 +24,7 @@ If the above sounds like latin to you, don't worry. You should be fine as long a Nimbus will build its own local copy of Nim, so Nim is not an external dependency, -## Linux +### Linux On common Linux distributions the dependencies can be installed with @@ -46,63 +46,6 @@ Assuming you use [Homebrew](https://brew.sh/) to manage packages ```sh brew install cmake ``` -# Quick start - -This page takes you through how to run just the beacon node without a validator attached. - -Running just a beacon node can help improve the anonymity properties of the network as a whole. - -### 1. Install dependencies - -You'll need to install some packages (`git`) in order for Nimbus to run correctly. - -To do so, run: -``` -sudo apt-get install git - -``` - -### 2. Clone the Nimbus repository - -Run the following command to clone the [nimbus-eth2 repository](https://github.com/status-im/nimbus-eth2): - -``` -git clone https://github.com/status-im/nimbus-eth2 -``` - -### 3. Build the beacon node - -Change into the directory and build the beacon node. -``` -cd nimbus-eth2 -make nimbus_beacon_node -``` - -*Patience... this may take a few minutes.* - -### 4. Connect to mainnet - -To connect to mainnet, run: -``` -./run-mainnet-beacon-node.sh -``` - -You'll be prompted to enter a web3-provider url: - -``` -To monitor the Eth1 validator deposit contract, you'll need to pair -the Nimbus beacon node with a Web3 provider capable of serving Eth1 -event logs. This could be a locally running Eth1 client such as Geth -or a cloud service such as Infura. For more information please see -our setup guide: - -https://status-im.github.io/nimbus-eth2/eth1.html - -Please enter a Web3 provider URL: -``` - -Press enter to skip (this is only important when you're running a validator). - ### Windows diff --git a/docs/the_nimbus_book/src/keep-an-eye.md b/docs/the_nimbus_book/src/keep-an-eye.md index e5207c022..660c09d5a 100644 --- a/docs/the_nimbus_book/src/keep-an-eye.md +++ b/docs/the_nimbus_book/src/keep-an-eye.md @@ -59,8 +59,4 @@ The number following it (in the above case represented by `7`) represents the nu > **Note:** If you're running Nimbus as a service, the above status bar won't be visible to you. You can use you the RPC calls outlined in the [API page](./api.md) to retrieve similar information. -## eth2stats - - -eth2stats is a network monitoring suite for your beacon node + validator client. One good pre-genesis check is to query your local node's API to see if you have peers. See our guide [here](./eth2-stats.md) for more. diff --git a/docs/the_nimbus_book/src/pi-guide.md b/docs/the_nimbus_book/src/pi-guide.md index 4fbe8e37a..7ad6b64c8 100644 --- a/docs/the_nimbus_book/src/pi-guide.md +++ b/docs/the_nimbus_book/src/pi-guide.md @@ -412,5 +412,5 @@ Verifying your progress is as simple as `ssh`ing back into your Pi and typing `s While `screen` is a nice tool for testing, it's not really a good idea to rely on it for serious use. For a more professional setup, we recommend [setting up a systemd service](https://www.raspberrypi.org/documentation/linux/usage/systemd.md) with an autorestart on boot (should you experience an unexpected power outage, this will ensure your validator restarts correctly). -For the details on how to do this, see [this page](./beacon-node-systemd.md) +For the details on how to do this, see [this page](./beacon-node-systemd.md).