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

restructure, merge, simplify (#2581)

This commit is contained in:
0xmiel 2021-05-19 16:12:25 +02:00 committed by GitHub
parent 07533f41ba
commit 199ebc995b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 46 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/the_nimbus_book/src/SUMMARY.md
View File

@ -3,46 +3,46 @@
- [Design goals](./philosophy.md)
- [System requirements](./hardware.md)
- [Run just the beacon node (quickstart)](./quick-start.md)
- [Run a validator]()
# Raspberry Pi
- [Validating with a Raspberry Pi](./pi-guide.md)
- [Mainnet advice](./pi-guide-mainnet.md)
# Rocket Pool
- [Introductory guide](./rp-quick-start.md)
# Prater testnet
- [What you should know](./prater.md)
# How-to
# How-to (beacon node)
- [Install dependencies](./install.md)
- [Build the beacon node](./build.md)
- [Run an eth1 node](./eth1.md)
- [Sync the beacon node](./start-syncing.md)
- [Add a backup web3 provider](./web3-backup.md)
# How-to (validator)
- [Make a deposit for your validator](./deposit.md)
- [Import your validator keys](./keys.md)
- [Connect your validator to eth2](./connect-eth2.md)
- [Keep an eye on your validator](./keep-an-eye.md)
- [Keep Nimbus updated](./keep-updated.md)
- [Add an additional validator](./additional-validator.md)
# How-to (misc)
- [Prepare for mainnet](./preparation.md)
- [Set up email notifications](./email-notifications.md)
- [Graffiti the blockchain](./graffiti.md)
- [Download binaries](./binaries.md)
- [Download Docker images](./docker.md)
- [Run an eth1 node](./eth1.md)
- [Recover / generate keys](./more-keys.md)
- [Perform a voluntary exit](./voluntary-exit.md)
- [Set up a systemd service](./beacon-node-systemd.md)
- [Set up log rotation](./log-rotate.md)
- [Verify the integrity of Nimbus](./checksums.md)
- [Back up your database](./database-backup.md)
- [Add a backup web3 provider](./web3-backup.md)
- [Add an additional validator](./additional-validator.md)
- [Migrate from another client](./migration.md)
- [Set up email notifications](./email-notifications.md)
- [Graffiti the blockchain](./graffiti.md)
# Tutorials
# Guides
- [Grafana and Prometheus](./metrics-pretty-pictures.md)
- [Create your own Infura endpoint](./infura-guide.md)
- [Network stats (testnets only)](./eth2-stats.md)
- [Migrating from another client](./migration.md)
- [Validating with a Raspberry Pi](./pi-guide.md)
- [Trying Rocket Pool](./rp-quick-start.md)
# Downloads
- [Download binaries](./binaries.md)
- [Download Docker images](./docker.md)
# Reference
- [API](./api.md)
@ -50,8 +50,8 @@
- [Advanced migration options](./migration-options.md)
- [Troubleshooting](./troubleshooting.md)
- [For developers](./developers.md)
- [FAQ](./faq.md)
- [Contribute](./contribute.md)
- [Resources](./resources.md)
- [Binary distribution internals](./distribution_internals.md)
- [Prater: What you should know](./prater.md)
- [FAQ](./faq.md)

20
docs/the_nimbus_book/src/pi-guide-mainnet.md
View File

@ -1,23 +1,3 @@
# Validating with a Raspberry Pi: Mainnet advice
Whether or not your Pi is up to the task will depend on a number of factors such as SSD speed, network connectivity, etc. As such, it's best to verify performance on a testnet first.
The best thing you can do is to set your Pi to run Pyrmont. **If you have no trouble syncing and attesting on Pyrmont, your setup should be more than good enough for mainnet** as well (Mainnet is expected to use fewer resources).
<blockquote class="twitter-tweet" data-conversation="none"><p lang="en" dir="ltr">We&#39;ve been running lots of PIs and NanoPCs 24/7 for 3 years and never got a hardware fail. It is easy (and cheap) to get redundancy of components (even spare PIs in different locations, more of this to come).</p>&mdash; Ethereum on ARM (@EthereumOnARM) <a href="https://twitter.com/EthereumOnARM/status/1332772217420177408?ref_src=twsrc%5Etfw">November 28, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
Although we don't expect a modern Pi to fail, we recommend buying a spare Pi, and enterprise grade SSD, on the off-chance it does; keep your original SD around, to make it easy for you to copy the image over.
### Systemd
In order to make sure your Pi autorestarts on boot, we recommend [setting up a systemd service](https://www.raspberrypi.org/documentation/linux/usage/systemd.md). For the details on how to do this, see [this page](./beacon-node-systemd.md).
### Overclocking
While you shouldn't need to, if you're feeling adventurous and want to try and squeeze out some extra performance out of your Pi's CPU, see [this guide](https://github.com/jclapis/rp-pi-guide/blob/main/Overclocking.md) by Joe Clapis.
> **Note:** we have since improved performance in several ways which should make a vanilla Pi perform well. However, overclocking may still give some benefits, in particular you have more performance to deal with anomalies (like spamming etc).

26
docs/the_nimbus_book/src/pi-guide.md
View File

@ -363,11 +363,33 @@ Keep an eye on the number of peers your currently connected to (in the above cas
> **Note:** 15 - 20 peers and an average sync speed of **0.5 - 1.0** blocks per second is normal on `Pyrmont` with a Pi. If you're sync speed is much slower than this, the root of the problem may be your USB3.0 to SSD adapter. See [this post](https://www.raspberrypi.org/forums/viewtopic.php?f=28&t=245931) for a recommended workaround.
### Professional setup advice
### Mainnet advice
Whether or not your Pi is up to the task will depend on a number of factors such as SSD speed, network connectivity, etc. As such, it's best to verify performance on a testnet first.
The best thing you can do is to set your Pi to run Prater. **If you have no trouble syncing and attesting on Prater, your setup should be more than good enough for mainnet** as well (Mainnet is expected to use fewer resources).
<blockquote class="twitter-tweet" data-conversation="none"><p lang="en" dir="ltr">We&#39;ve been running lots of PIs and NanoPCs 24/7 for 3 years and never got a hardware fail. It is easy (and cheap) to get redundancy of components (even spare PIs in different locations, more of this to come).</p>&mdash; Ethereum on ARM (@EthereumOnARM) <a href="https://twitter.com/EthereumOnARM/status/1332772217420177408?ref_src=twsrc%5Etfw">November 28, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
Although we don't expect a modern Pi to fail, we recommend buying a spare Pi, and enterprise grade SSD, on the off-chance it does; keep your original SD around, to make it easy for you to copy the image over.
#### Systemd
Now that you have Nimbus up and running, 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).
Systemd will also ensure your validator keeps running when you exit your ssh session (`Ctrl-C`) and/or switch off your laptop.
For the details on how to set up a systemd service, see [this page](./beacon-node-systemd.md).
For the details on how to do this, see [this page](./beacon-node-systemd.md).
#### Overclocking
While you shouldn't need to, if you're feeling adventurous and want to try and squeeze out some extra performance out of your Pi's CPU, see [this guide](https://github.com/jclapis/rp-pi-guide/blob/main/Overclocking.md) by Joe Clapis.
> **Note:** we have since improved performance in several ways which should make a vanilla Pi perform well. However, overclocking may still give some benefits, in particular you have more performance to deal with anomalies (like spamming etc).