feat: add part of Nimbus Linux docs

This commit is contained in:
RadoslavDimchev 2023-11-01 13:48:10 +02:00
parent c5d6d1df0a
commit dfc4994a40

View File

@ -64,9 +64,10 @@ export const DOCUMENTATIONS: Documentation = {
general:
"## Beacon node\nThis page takes you through the steps of getting a standard installation of the Nimbus beacon node running.\n\nThe quickstart setup involves running two nodes: an [execution client](https://nimbus.guide/eth1.html) and a beacon node. Both are needed to run a full Ethereum setup.\n\nTo become a validator, you first need to set up a beacon node. The beacon node connects to the beacon chain network, syncs historical data, and provides [API's](https://nimbus.guide/rest-api.html) to monitor and interact with the beacon chain. Running a beacon node is a [worthwhile endeavor](https://vitalik.ca/general/2021/05/23/scaling.html#its-crucial-for-blockchain-decentralization-for-regular-users-to-be-able-to-run-a-node) even if you are not planning on validating yourself!\n\nThe guide assumes [Ubuntu Linux](https://ubuntu.com/download/server) is being used, and therefore some familiarity with [the Linux command line](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview) is needed.\n\n**Tip**\n\nYou can practice running the node safely on the [Holesky testnet](https://nimbus.guide/holesky.html). Throughout, we'll provide instructions for both Holesky and Mainnet.",
documentation: {
[MAC]: 'Text for mac',
[WINDOWS]: 'Text for windows',
[LINUX]: 'Text for linux',
[MAC]: '',
[WINDOWS]: '',
[LINUX]:
"### Steps\n**1. Prepare**\n\nPrepare your machine by installing [Nimbus' dependencies](https://nimbus.guide/install.html).\n\n**2. Set up an execution client**\n\nTo run a beacon node, you need to have access to an execution client exposing the web3 API. Throughout, we'll assume an execution client is running on the same machine as the beacon node, but this is not required.\n\nSee the [execution client guide](https://nimbus.guide/eth1.html) for instructions on how to pick and install an execution client.\n\n**3. Install Nimbus**\n\n**Download binaries**\n\n- Binary releases are available from [GitHub](https://github.com/status-im/nimbus-eth2/releases/tag/v23.10.0) and our [APT repository](https://apt.status.im/) (Debian/Ubuntu).\n\n- We currently have binaries available for Linux `AMD64`, `ARM` and `ARM64`, Windows `AMD64`, and macOS (`AMD64` and `ARM64`).\nSee the [binaries guide](https://nimbus.guide/binaries.html) on how to install them.\n\n**Build from source**\n\n- Building Nimbus from source is simple and fully automated. Follow the [build guide](https://nimbus.guide/build.html).\n\n**4. Sync from a trusted node**\n\nWhile this step is not mandatory, since Nimbus will automatically start syncing process on the first start, we recommend doing it as it will allow you to get started in **minutes** instead of hours or even days.\n our [trusted node sync guide](https://nimbus.guide/trusted-node-sync.html).\n\n**5. Start the node**\n\nOnce you've completed previous steps, it is time to start the beacon node.\n\nIf you have skipped the syncing from a trusted node step, starting the node will initiate the [syncing process](https://nimbus.guide/start-syncing.html).\n\n`cd nimbus-eth2`\n\n**Mainnet**",
},
},
}