2022-07-24 22:13:47 +02:00
|
|
|
# Build from source
|
2020-10-26 18:12:37 +01:00
|
|
|
|
2023-04-11 17:42:35 +02:00
|
|
|
Building Nimbus from source ensures that all hardware-specific optimizations are turned on.
|
|
|
|
The build process itself is simple and fully automated, but may take a few minutes.
|
2022-07-21 20:19:47 +02:00
|
|
|
|
2022-07-24 22:13:47 +02:00
|
|
|
!!! note "Nim"
|
2023-04-11 17:42:35 +02:00
|
|
|
Nimbus is written in the [Nim](https://nim-lang.org) programming language.
|
|
|
|
The correct version will automatically be downloaded as part of the build process!
|
2022-07-21 20:19:47 +02:00
|
|
|
|
2020-10-26 18:12:37 +01:00
|
|
|
## Prerequisites
|
|
|
|
|
2023-06-10 01:06:01 +02:00
|
|
|
Make sure you have all needed [build prerequisites](./install.md#build-prerequisites).
|
2020-10-26 18:12:37 +01:00
|
|
|
|
|
|
|
## Building the node
|
|
|
|
|
2022-06-19 09:24:01 +02:00
|
|
|
### 1. Clone the `nimbus-eth2` repository
|
2020-10-26 18:12:37 +01:00
|
|
|
|
2022-06-19 09:24:01 +02:00
|
|
|
```sh
|
2020-10-26 18:12:37 +01:00
|
|
|
git clone https://github.com/status-im/nimbus-eth2
|
|
|
|
cd nimbus-eth2
|
|
|
|
```
|
|
|
|
|
2020-11-07 16:52:40 +01:00
|
|
|
### 2. Run the beacon node build process
|
2020-10-26 18:12:37 +01:00
|
|
|
|
2022-07-21 20:19:47 +02:00
|
|
|
To build the Nimbus beacon node and its dependencies, run:
|
2020-10-26 18:12:37 +01:00
|
|
|
|
2022-06-19 09:24:01 +02:00
|
|
|
```sh
|
|
|
|
make -j4 nimbus_beacon_node
|
2020-10-26 18:12:37 +01:00
|
|
|
```
|
2021-03-05 09:53:55 +01:00
|
|
|
|
2022-07-22 21:47:24 +02:00
|
|
|
!!! tip
|
|
|
|
Omit `-j4` on systems with 4GB of memory or less.
|
2023-06-10 01:06:01 +02:00
|
|
|
|
|
|
|
This step can take several minutes.
|
|
|
|
After it has finished, you can check if the installation was successful by running:
|
|
|
|
|
|
|
|
```sh
|
|
|
|
build/nimbus_beacon_node --help
|
|
|
|
```
|
|
|
|
|
|
|
|
If you see the command-line options, your installation was successful!
|
|
|
|
Otherwise, don't hesitate to reach out to us in the `#helpdesk` channel of [our discord](https://discord.gg/j3nYBUeEad).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Keeping Nimbus updated
|
|
|
|
|
|
|
|
When you decide to upgrade Nimbus to a newer version, make sure to follow the [keeping updated guide](./keep-updated.md).
|