nimbus-eth2/docs/the_nimbus_book/src/install.md

67 lines
1.8 KiB
Markdown
Raw Normal View History

2020-05-02 13:14:19 +00:00
# Installation
2020-06-19 15:30:05 +00:00
Beacon chain can run on Linux, macOS, Windows, and Android. At the moment, Nimbus has to be built from source.
2020-06-19 13:14:12 +00:00
2020-07-03 16:03:06 +00:00
## Time
The beacon chain relies on your computer having the correct time set, down to at most 0.5 seconds.
It is recommended that you run a high quality time service on your computer such as:
* GPS
* NTS (network time security, IETF draft)
* Roughtime (google)
As a minimum, you should run an NTP client on the server - NTP may easily be disrupted however.
2020-06-19 13:14:12 +00:00
## External Dependencies
2020-05-02 13:14:19 +00:00
- Developer tools (C compiler, Make, Bash, Git)
- PCRE
2020-06-19 13:14:12 +00:00
2020-05-02 13:14:19 +00:00
Nim is not an external dependency, Nimbus will build its own local copy.
## Linux
On common Linux distributions the dependencies can be installed with:
2020-06-19 13:14:12 +00:00
2020-05-02 13:14:19 +00:00
```sh
# Debian and Ubuntu
sudo apt-get install build-essential git libpcre3-dev
# Fedora
dnf install @development-tools pcre
# Archlinux, using an AUR manager for pcre-static
yourAURmanager -S base-devel pcre-static
```
2020-06-19 13:14:12 +00:00
### macOS
2020-05-02 13:14:19 +00:00
Assuming you use [Homebrew](https://brew.sh/) to manage packages
```sh
2020-07-06 11:47:26 +00:00
brew install pcre cmake
2020-05-02 13:14:19 +00:00
```
### Windows
You can install the developer tools by following the instruction in our [Windows dev environment section](./advanced.md#windows-dev-environment).
It also provides a downloading script for prebuilt PCRE.
### Android
2020-06-19 13:14:12 +00:00
- Install the [Termux](https://termux.com) app from FDroid or the Google Play store
- Install a [PRoot](https://wiki.termux.com/wiki/PRoot) of your choice following the instructions for your preferred distribution.
Note, the Ubuntu PRoot is known to contain all Nimbus prerequisites compiled on Arm64 architecture (common architecture for Android devices).
2020-05-02 13:14:19 +00:00
2020-06-19 13:14:12 +00:00
_Assuming Ubuntu PRoot is used_
2020-05-02 13:14:19 +00:00
```sh
apt install build-essential git libpcre3-dev
```
2020-06-29 12:04:01 +00:00
## Next steps
2020-07-03 16:03:06 +00:00
Once you've installed the prerequisites, you're ready to move on to launching the [beacon node](./beacon_node.md).