From 187eabeeb9f8b4ea4a89ebd57a86f9822fc8fb5b Mon Sep 17 00:00:00 2001 From: TennisBowling <33209196+TennisBowling@users.noreply.github.com> Date: Sat, 5 Mar 2022 23:40:17 -0800 Subject: [PATCH] Docs fix (#3397) * geth is bigger * Update preparation.md * Update install.md * Update start-syncing.md * Update docs/the_nimbus_book/src/start-syncing.md Co-authored-by: Jacek Sieka * Update install.md * Update docs/the_nimbus_book/src/hardware.md Co-authored-by: sacha * Update docs/the_nimbus_book/src/install.md Co-authored-by: sacha * Update docs/the_nimbus_book/src/install.md Co-authored-by: sacha * Update docs/the_nimbus_book/src/install.md Co-authored-by: sacha * Update docs/the_nimbus_book/src/start-syncing.md Co-authored-by: sacha * Update docs/the_nimbus_book/src/preparation.md Co-authored-by: sacha * Update docs/the_nimbus_book/src/preparation.md Co-authored-by: sacha Co-authored-by: Jacek Sieka Co-authored-by: sacha --- docs/the_nimbus_book/src/hardware.md | 4 ++-- docs/the_nimbus_book/src/install.md | 25 +++++++++++++++++------ docs/the_nimbus_book/src/preparation.md | 9 +++----- docs/the_nimbus_book/src/start-syncing.md | 4 ++-- 4 files changed, 26 insertions(+), 16 deletions(-) diff --git a/docs/the_nimbus_book/src/hardware.md b/docs/the_nimbus_book/src/hardware.md index a86c45e8b..8e808e232 100644 --- a/docs/the_nimbus_book/src/hardware.md +++ b/docs/the_nimbus_book/src/hardware.md @@ -14,7 +14,7 @@ In order to process incoming validator deposits from the eth1 chain, you will need to run an eth1 client in parallel to your eth2 client. While it is possible to use a third-party service like [Infura](/infura-guide.md), if you choose to run your own eth1 client locally, you'll need more memory and storage. -For example, you'll need at least another **500GB SSD** to run [geth fast sync](/eth1.md) on mainnet. +For example, you'll need at least another **1TB SSD** to run [geth fast sync](/eth1.md) on mainnet. -To future proof your setup we recommend a **1TB SSD**. +To future proof your setup we recommend a **2TB SSD**. diff --git a/docs/the_nimbus_book/src/install.md b/docs/the_nimbus_book/src/install.md index ad14e1d04..f5afd73b0 100644 --- a/docs/the_nimbus_book/src/install.md +++ b/docs/the_nimbus_book/src/install.md @@ -6,15 +6,28 @@ The Nimbus beacon chain can run on Linux, macOS, Windows, and Android. At the mo The beacon chain relies on your computer having the correct time set (plus or minus 0.5 seconds). -We recommended you run a high quality time service on your computer such as: +We recommended you run a high quality time service on your computer such as [chrony](https://chrony.tuxfamily.org/). +Chrony is much more performant than the default NTP server. +It's a simple install: -* GPS -* NTS (network time security, [IETF draft](https://tools.ietf.org/html/draft-ietf-ntp-using-nts-for-ntp-19)) -* [Roughtime](https://roughtime.googlesource.com/roughtime) (google) +```sh +# Debian and Ubuntu +sudo apt-get install -y chrony -At a minimum, you should run an NTP client on the server. +# Fedora +dnf install chrony -> **Note:** Most operating systems (including macOS') automatically sync with NTP by default. +# Archlinux, using an AUR manager +yourAURmanager chrony +``` + +Chrony will uninstall any existing NTP servers. + +It's available on most package managers. + +Once installed, the default configuration is good enough. + +At a minimum, you should run an NTP client (such as chrony) on the server. Note that most operating systems (including macOS') automatically sync with NTP by default. If the above sounds like latin to you, don't worry. You should be fine as long as you haven't messed around with the time and date settings on your computer (they should be set automatically). diff --git a/docs/the_nimbus_book/src/preparation.md b/docs/the_nimbus_book/src/preparation.md index 81b07af4d..edd972072 100644 --- a/docs/the_nimbus_book/src/preparation.md +++ b/docs/the_nimbus_book/src/preparation.md @@ -5,11 +5,11 @@ Please check that you are running the latest stable [Nimbus software release](https://github.com/status-im/nimbus-eth2/releases). -> **Note:** If you are setting up your client before launch, it is your responsibility to check for any new software releases in the run up to launch. At the minimum you should check the [release page](https://github.com/status-im/nimbus-eth2/releases) weekly. +> In order to stay on top of new releases you should subscribe to [our mailing list](https://subscribe.nimbus.team/). ## More than 15 peers -Please check that your node has at least 15 peers. To monitor your peer count, pay attention to the [`Slot start` messages in your logs](keep-an-eye.md#keep-track-of-your-syncing-progress). +Please check that your node has at least 15 peers. To monitor your peer count, pay attention to the [`Slot start` messages in your logs](keep-an-eye.md#keep-track-of-your-syncing-progress). See the [networking page](networking.md) for more tips. ## Validator attached @@ -17,14 +17,11 @@ Please check that your [validator is attached](keep-an-eye.md#make-sure-your-val ## 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). +Now that you have Nimbus up and running, we recommend [setting up a systemd service](beacon-node-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 do this, see [this page](./beacon-node-systemd.md). - - ## Ethereum Foundation's Checklist Ad a final check, we recommend you also go through the EF'S [staker checklist](https://launchpad.ethereum.org/checklist). diff --git a/docs/the_nimbus_book/src/start-syncing.md b/docs/the_nimbus_book/src/start-syncing.md index d7bf81fe3..96d8d9ae2 100644 --- a/docs/the_nimbus_book/src/start-syncing.md +++ b/docs/the_nimbus_book/src/start-syncing.md @@ -4,9 +4,9 @@ To minimize the amount of downtime, you should ensure that your beacon node is [ This is particularly important if you are joining a network that's been running for a while since the sync could take some time. -> **N.B.** In order to process incoming validator deposits from the eth1 chain, you'll need to run an eth1 client (**web3 provider**) in parallel to your eth2 client. See [here](./eth1.md) for instructions on how to do so. +> **Tip:** If you'd like to sync faster and start attesting immediately, we recommend taking a look at [trusted node sync](./trusted-node-sync.md) -If you have access to a node that you trust, you can get started more quickly using [trusted node sync](./trusted-node-sync.md). +> **N.B.** In order to process incoming validator deposits from the eth1 chain, you'll need to run an eth1 client (**web3 provider**) in parallel to your eth2 client. See [here](./eth1.md) for instructions on how to do so. ### Testnet