[DOCS] Update installation guide (#20278)
This commit is contained in:
Chris Chinchilla
Felix Lange
parent
e140b09174
commit
c8c6908e9a
|
|
@ -6,7 +6,8 @@ sort_key: A
|
|||
You can install the Go implementation of Ethereum using a variety of ways. These include installing it via your favorite package manager; downloading a standalone pre-built bundle; running as a docker container; or building it yourself. This document details all of the possibilities to get you joining the Ethereum network using whatever means you prefer.
|
||||
|
||||
{:toc}
|
||||
* this will be removed by the toc
|
||||
|
||||
- this will be removed by the toc
|
||||
|
||||
## Install from a package manager
|
||||
|
||||
|
|
@ -22,23 +23,19 @@ brew tap ethereum/ethereum
|
|||
brew install ethereum
|
||||
```
|
||||
|
||||
You can install the develop branch using the `--devel` parameter:
|
||||
You can install the master branch using the `--devel` parameter:
|
||||
|
||||
```shell
|
||||
brew install ethereum --devel
|
||||
```
|
||||
|
||||
After installing, run `geth account new` to create an account on your node.
|
||||
The `abigen`, `bootnode`, `checkpoint-admin`, `clef`, `devp2p`, `ethkey`, `evm`, `faucet`, `geth`, `p2psim`, `puppeth`, `rlpdump`, and `wnode` commands are then available on your system in `/usr/local/bin/`.
|
||||
|
||||
You should now be able to run `geth` and connect to the network.
|
||||
|
||||
Check the different options and commands with `geth --help`
|
||||
|
||||
For options and patches, see: <https://github.com/ethereum/homebrew-ethereum>
|
||||
Find the different options and commands available with `geth --help`.
|
||||
|
||||
### Install on Ubuntu via PPAs
|
||||
|
||||
The easiest way to install go-ethereum on Ubuntu-based distributions is with the built in launchpad PPAs (Personal Package Archives). We provide a single PPA repository that contains both our stable and develop releases for Ubuntu versions `trusty`, `xenial`, `zesty` and `artful`.
|
||||
The easiest way to install go-ethereum on Ubuntu-based distributions is with the built-in launchpad PPAs (Personal Package Archives). We provide a single PPA repository that contains both our stable and development releases for Ubuntu versions `trusty`, `xenial`, `zesty` and `artful`.
|
||||
|
||||
To enable our launchpad repository run:
|
||||
|
||||
|
|
@ -60,18 +57,28 @@ sudo apt-get update
|
|||
sudo apt-get install ethereum-unstable
|
||||
```
|
||||
|
||||
### Install on FreeBSD via `pkg`
|
||||
The `abigen`, `bootnode`, `clef`, `evm`, `geth`, `puppeth`, `rlpdump`, and `wnode` commands are then available on your system in `/usr/bin/`.
|
||||
|
||||
Find the different options and commands available with `geth --help`.
|
||||
|
||||
### Install on Windows
|
||||
|
||||
The easiest way to install go-ethereum is to download a pre-compiled binary from the [downloads](https://geth.ethereum.org/downloads/) page. The page provides an installer as well as a zip file. The installer puts `geth` into your `PATH` automatically. The zip file contains the command `.exe` files that you can use without installing by runnning it from the command prompt.
|
||||
|
||||
### Install on FreeBSD via pkg
|
||||
|
||||
```shell
|
||||
pkg install go-ethereum
|
||||
```
|
||||
|
||||
The `geth` command is then available on your system in `/usr/local/bin/geth`, you can start it on the testnet (for example) by using:
|
||||
The `geth` command is then available on your system in `/usr/local/bin/`. You can create a new account on your node with:
|
||||
|
||||
```shell
|
||||
geth -rinkeby
|
||||
geth account new
|
||||
```
|
||||
|
||||
Find the different options and commands available with `geth --help`.
|
||||
|
||||
### Install on FreeBSD via ports
|
||||
|
||||
Go to the `net-p2p/go-ethereum` ports directory:
|
||||
|
|
@ -86,6 +93,10 @@ Then build it the standard way (as root):
|
|||
make install
|
||||
```
|
||||
|
||||
The `abigen`, `bootnode`, `clef`, `evm`, `geth`, `puppeth`, `rlpdump`, and `wnode` commands are then available on your system in `/usr/local/bin/`.
|
||||
|
||||
Find the different options and commands available with `geth --help`.
|
||||
|
||||
### Install on Arch Linux via `pacman`
|
||||
|
||||
The `geth` package is available from the [community repo](https://www.archlinux.org/packages/community/x86_64/geth/).
|
||||
|
|
@ -96,9 +107,13 @@ You can install it using:
|
|||
pacman -S geth
|
||||
```
|
||||
|
||||
The `abigen`, `bootnode`, `clef`, `evm`, `geth`, `puppeth`, `rlpdump`, and `wnode` commands are then available on your system in `/usr/bin/`.
|
||||
|
||||
Find the different options and commands available with `geth --help`.
|
||||
|
||||
## Download standalone bundle
|
||||
|
||||
We distribute our stable releases and develop builds as standalone bundles. These are useful when you'd like to: a) install a specific version of our code (e.g., for reproducible environments); b) install on machines without internet access (e.g., air-gapped computers); or c) do not like automatic updates and would rather manually install software.
|
||||
We distribute our stable releases and development builds as standalone bundles. These are useful when you'd like to: a) install a specific version of our code (e.g., for reproducible environments); b) install on machines without internet access (e.g., air-gapped computers); or c) do not like automatic updates and would rather manually install software.
|
||||
|
||||
We create the following standalone bundles:
|
||||
|
||||
|
|
@ -106,22 +121,29 @@ We create the following standalone bundles:
|
|||
- 64bit archives (`.tar.gz`) on macOS
|
||||
- 32bit and 64bit archives (`.zip`) and installers (`.exe`) on Windows
|
||||
|
||||
For all archives we provide separate ones containing only Geth, and separate ones containing Geth along with all the developer tools from our repository (`abigen`, `bootnode`, `disasm`, `evm`, `rlpdump`). Read our [`README`](https://github.com/ethereum/go-ethereum#executables) for more information about these executables.
|
||||
We provide archives containing only Geth, and archives containing Geth along with the developer tools from our repository (`abigen`, `bootnode`, `disasm`, `evm`, `rlpdump`). Read our [`README`](https://github.com/ethereum/go-ethereum#executables) for more information about these executables.
|
||||
|
||||
Download these bundles from the [Go Ethereum Downloads](https://geth.ethereum.org/downloads) page.
|
||||
|
||||
## Run inside Docker container
|
||||
|
||||
If you prefer containerized processes, you can run go-ethereum as a Docker container. We maintain four different Docker images for running the latest stable or develop versions of Geth.
|
||||
If you prefer containerized processes, we maintain a Docker image with recent snapshot builds from our `develop` branch on DockerHub. We maintain four different Docker images for running the latest stable or development versions of Geth.
|
||||
|
||||
- `ethereum/client-go:latest` is the latest develop version of Geth
|
||||
- `ethereum/client-go:latest` is the latest development version of Geth (default)
|
||||
- `ethereum/client-go:stable` is the latest stable version of Geth
|
||||
- `ethereum/client-go:{version}` is the stable version of Geth at a specific version number
|
||||
- `ethereum/client-go:release-{version}` is the latest stable version of Geth at a specific version family
|
||||
|
||||
We also maintain four different Docker images for running the latest stable or develop versions of miscellaneous Ethereum tools.
|
||||
To pull an image and start a node, run these commands:
|
||||
|
||||
- `ethereum/client-go:alltools-latest` is the latest develop version of the Ethereum tools
|
||||
```shell
|
||||
docker pull ethereum/client-go
|
||||
docker run -it -p 30303:30303 ethereum/client-go
|
||||
```
|
||||
|
||||
We also maintain four different Docker images for running the latest stable or development versions of miscellaneous Ethereum tools.
|
||||
|
||||
- `ethereum/client-go:alltools-latest` is the latest development version of the Ethereum tools
|
||||
- `ethereum/client-go:alltools-stable` is the latest stable version of the Ethereum tools
|
||||
- `ethereum/client-go:alltools-{version}` is the stable version of the Ethereum tools at a specific version number
|
||||
- `ethereum/client-go:alltools-release-{version}` is the latest stable version of the Ethereum tools at a specific version family
|
||||
|
|
@ -137,27 +159,49 @@ _Note, if you are running an Ethereum client inside a Docker container, you shou
|
|||
|
||||
## Build go-ethereum from source code
|
||||
|
||||
### Most Linux systems
|
||||
### Most Linux systems and macOS
|
||||
|
||||
Go Ethereum is written in [Go](https://golang.org), so to build from source code you need the most recent version of Go. This guide doesn't cover how to install Go itself, for details read the [Go installation instructions](https://golang.org/doc/install) and grab any needed bundles from the [Go download page](https://golang.org/dl/).
|
||||
|
||||
With Go installed, you can download our project via:
|
||||
With Go installed, you can download the project into you `GOPATH` workspace via:
|
||||
|
||||
```shell
|
||||
go get -d github.com/ethereum/go-ethereum
|
||||
```
|
||||
|
||||
The above command checks out the default version of Go Ethereum into your local `GOPATH` work space, but does not build any executables. To do that you can either build one specifically:
|
||||
The above command does not build any executables. To do that you can either build one specifically:
|
||||
|
||||
```shell
|
||||
go install github.com/ethereum/go-ethereum/cmd/geth
|
||||
```
|
||||
|
||||
Or you can build the entire project and install `geth` along with all developer tools by running `go install ./...` in the repository root inside your `GOPATH` work space.
|
||||
Or you can build the entire project and install `geth` along with all developer tools by running `go install ./...` in the `ethereum/go-ethereum` repository root inside your `GOPATH` workspace.
|
||||
|
||||
### macOS
|
||||
If you are using macOS and see errors related to macOS header files, install XCode Command Line Tools with `xcode-select --install`, and try again.
|
||||
|
||||
If you see errors related to macOS header files, install XCode Command Line Tools with `xcode-select --install`, and try again.
|
||||
### Windows
|
||||
|
||||
The Chocolatey package manager provides an easy way to get the required build tools installed. If you don't have chocolatey, [follow the instructions](https://chocolatey.org) to install it first.
|
||||
|
||||
Then open an Administrator command prompt and install the build tools you need:
|
||||
|
||||
```shell
|
||||
C:\Windows\system32> choco install git
|
||||
C:\Windows\system32> choco install golang
|
||||
C:\Windows\system32> choco install mingw
|
||||
```
|
||||
|
||||
Installing these packages sets up the path environment variables, you need to open a new command prompt to get the new path.
|
||||
|
||||
The following steps don't need Administrator privileges. First create and set up a Go workspace directory layout, then clone the source and build it.
|
||||
|
||||
```shell
|
||||
C:\Users\xxx> mkdir src\github.com\ethereum
|
||||
C:\Users\xxx> git clone https://github.com/ethereum/go-ethereum src\github.com\ethereum\go-ethereum
|
||||
C:\Users\xxx> cd src\github.com\ethereum\go-ethereum
|
||||
C:\Users\xxx> go get -u -v golang.org/x/net/context
|
||||
C:\Users\xxx\src\github.com\ethereum\go-ethereum> go install -v ./cmd/...
|
||||
```
|
||||
|
||||
### FreeBSD
|
||||
|
||||
|
|
@ -193,7 +237,7 @@ You can now run `build/bin/geth` to start your node.
|
|||
|
||||
### Building without a Go workflow
|
||||
|
||||
If you do not want to set up Go workspaces on your machine, only build `geth` and forget about the build process, you can clone our repository directly into a folder of your choosing and invoke `make`, which configures everything for a temporary build and cleans up afterwards. Note that this method of building only works on UNIX-like operating systems.
|
||||
If you do not want to set up Go workspaces on your machine, but only build `geth` and forget about the build process, you can clone our repository and use the `make` command, which configures everything for a temporary build and cleans up afterwards. This method of building only works on UNIX-like operating systems, and you still need Go installed.
|
||||
|
||||
```shell
|
||||
git clone https://github.com/ethereum/go-ethereum.git
|
||||
|
|
@ -201,4 +245,4 @@ cd go-ethereum
|
|||
make geth
|
||||
```
|
||||
|
||||
This creates a `geth` executable file in the `go-ethereum/build/bin` folder that you can move wherever you want to run from. The binary is standalone and doesn't require any additional files.
|
||||
These commands create a `geth` executable file in the `go-ethereum/build/bin` folder that you can move wherever you want to run from. The binary is standalone and doesn't require any additional files.
|
||||
|
|
|
|||
Loading…
Reference in New Issue