gaspersic/go-ethereum
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

changes made in berlin

Browse Source
This commit is contained in:
Martin Holst Swende
2019-09-04 13:51:21 +02:00
parent c49abfc4a8
commit fadeac7dec
12 changed files with 108 additions and 401 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/_install-and-build/Backup--restore.md
View File

@ -3,6 +3,13 @@ title: Backup & restore
---
**DO NOT FORGET YOUR PASSWORD** and **BACKUP YOUR KEYSTORE**
<!--
This whole page can be nuked, _except_ for the info about
where the keystore is located and advise the user
to back up his keystore. That section should be moved
into both accounts-info but also to any getting-started guide.
-->
# Backup & restore
## Data directory

22
docs/_install-and-build/Building-Ethereum.md
View File

@ -1,22 +0,0 @@
---
title: Building Geth
---
## Installation Instructions
Follow the appropriate link below to find installation instructions for
your platform.
* [Installation Instructions for Mac OS X](Installation-Instructions-for-Mac)
* [Installation Instructions for Windows](Installing-Geth)
* Installation Instructions for Linux/Unix
* [Ubuntu](Installing-Geth)
* [Arch](Installation-Instructions-for-Arch)
* [FreeBSD](Installation-Instructions-for-FreeBSD)
* [Setup for Raspberry Pi](https://github.com/ethereum/wiki/wiki/Raspberry-Pi-instructions)
* [ARM](Installation-Instructions-for-ARM)
* [Usage instructions for Docker](Running-in-Docker)
## Quick Links
* [Ubuntu PPA](https://launchpad.net/~ethereum/+archive/ubuntu/ethereum)
* [Download Page](https://geth.ethereum.org/downloads)

4
docs/_install-and-build/Developers-Guide.md
View File

@ -2,7 +2,7 @@
title: Developers' guide
---
**NOTE: These instructions are for people who want to contribute Go source code changes.
If you just want to run ethereum, use the normal [Installation Instructions](Building-Ethereum)**
If you just want to run ethereum, use the normal [Installation Instructions](Installing-Geth)**
This document is the entry point for developers of the Go implementation of Ethereum. Developers here refer to the hands-on: who are interested in build, develop, debug, submit a bug report or pull request or contribute code to go-ethereum.
@ -10,7 +10,7 @@ This document is the entry point for developers of the Go implementation of Ethe
### Go Environment
We assume that you have [`go` v1.8 installed](../doc/Installing-Go), and `GOPATH` is set.
We assume that you have [`go` installed](https://golang.org/doc/install), and `GOPATH` is set.
**Note**:You must have your working copy under `$GOPATH/src/github.com/ethereum/go-ethereum`.

13
docs/_install-and-build/Installation-Instructions-for-ARM.md
View File

@ -1,13 +0,0 @@
---
title: Installation instructions for ARM
---
Geth is built for ARM using cross-compilation. See [Cross compiling Ethereum](Cross-compiling-Ethereum) for more details.
## RasPi 2
1. Download the precompiled binary from https://geth.ethereum.org/downloads/
1. Copy it to a location in $PATH (i.e. /usr/local/bin)
1. Run `geth`
Further details: https://github.com/ethereum/wiki/wiki/Raspberry-Pi-instructions

25
docs/_install-and-build/Installation-Instructions-for-Arch.md
View File

@ -1,25 +0,0 @@
---
title: Installation instructions for Arch
---
## Installing using pacman
The `geth` package is available from the [community repo](https://www.archlinux.org/packages/community/x86_64/geth/).
You can install it using
```shell
pacman -S geth
```
## Installing from source
Install dependencies
```shell
pacman -S git go gcc
```
Download and build geth
```shell
git clone https://github.com/ethereum/go-ethereum
cd go-ethereum
make geth
```

60
docs/_install-and-build/Installation-Instructions-for-FreeBSD.md
View File

@ -1,60 +0,0 @@
---
title: Installation instructions for FreeBSD
---
## Building from source
### Installing binary package
Binary packages tend not to be up to date (1.8.9 at the time of writing) with the latest version (1.8.16 at the time of writing). It is recommended that you use ports or compile it yourself.
```shell
pkg install go-ethereum
```
The `geth` command is then available on your system in `/usr/local/bin/geth`, you can start it e.g. on the testnet by typing:
```shell
geth -rinkeby
```
### Using ports
Go to the `net-p2p/go-ethereum` ports directory:
```shell
cd /usr/ports/net-p2p/go-ethereum
```
Then build it the standard way (as root):
```shell
make install
```
### Building Geth (command line client)
Ports are slightly more up to date (1.8.14 at the time of writing)
Clone the repository to a directory of your choosing:
```shell
git clone https://github.com/ethereum/go-ethereum
```
Building `geth` requires the Go compiler:
```shell
pkg install go
```
If your golang version is >= 1.5, build the `geth` program using the following command.
```shell
cd go-ethereum
make geth
```
If your golang version is < 1.5 (quarterly packages, for example), use the following command instead.
```shell
cd go-ethereum
CC=clang make geth
```
You can now run `build/bin/geth` to start your node.

60
docs/_install-and-build/Installation-Instructions-for-Mac.md
View File

@ -1,60 +0,0 @@
---
title: Installation instructions for macOS
---
## Installing with Homebrew
By far the easiest way to install go-ethereum is to use our
Homebrew tap. If you don't have Homebrew, [install it first](http://brew.sh).
Then run the following commands to add the tap and install `geth`:
```shell
brew tap ethereum/ethereum
brew install ethereum
```
You can install the develop branch using the `--devel` parameter:
```shell
brew install ethereum --devel
```
After installing, run `geth account new` to create an account on your node.
You should now be able to run `geth` and connect to the network.
Make sure to check the different options and commands with `geth --help`
For options and patches, see: <https://github.com/ethereum/homebrew-ethereum>
## Building from source
### Building Geth (command line client)
Clone the repository to a directory of your choosing:
```shell
git clone https://github.com/ethereum/go-ethereum
```
Building `geth` requires the Go compiler:
```shell
brew install go
```
Finally, build the `geth` program using the following command.
```shell
cd go-ethereum
make geth
```
If you see some errors related to header files of Mac OS system library, install XCode Command Line Tools, and try again.
```shell
xcode-select --install
```
You can now run `build/bin/geth` to start your node.

6
docs/_install-and-build/Installation-Instructions-for-Ubuntu.md
View File

@ -1,6 +0,0 @@
Or the development version with:
```shell
sudo apt-get update
sudo apt-get install ethereum-unstable
```

104
docs/_install-and-build/Installing-Geth.md
View File

@ -6,7 +6,6 @@ The Go implementation of Ethereum can be installed using a variety of ways. Thes
* [Install from a package manager](#install-from-a-package-manager)
* [Install on macOS via Homebrew](#install-on-macos-via-homebrew)
* [Install on Ubuntu via PPAs](#install-on-ubuntu-via-ppas)
* [Install on Windows via Chocolatey](#install-on-windows-via-chocolatey)
* [Download standalone bundle](#download-standalone-bundle)
* [Run inside docker container](#run-inside-docker-container)
* [Build it from source code](#build-it-from-source-code)
@ -16,6 +15,31 @@ The Go implementation of Ethereum can be installed using a variety of ways. Thes
### Install on macOS via Homebrew
By far the easiest way to install go-ethereum is to use our
Homebrew tap. If you don't have Homebrew, [install it first](http://brew.sh).
Then run the following commands to add the tap and install `geth`:
```shell
brew tap ethereum/ethereum
brew install ethereum
```
You can install the develop branch using the `--devel` parameter:
```shell
brew install ethereum --devel
```
After installing, run `geth account new` to create an account on your node.
You should now be able to run `geth` and connect to the network.
Make sure to check the different options and commands with `geth --help`
For options and patches, see: <https://github.com/ethereum/homebrew-ethereum>
### Install on Ubuntu via PPAs
The simplest way to install go-ethereum on Ubuntu distributions is via the built in launchpad PPAs (Personal Package Archives). We provide a single PPA repository that contains both our stable as well as our develop releases for Ubuntu versions `trusty`, `xenial`, `zesty` and `artful`.
@ -40,9 +64,40 @@ sudo apt-get update
sudo apt-get install ethereum-unstable
```
### Install on Windows via Chocolatey
### Installing on FreeBSD using `pkg`
Although we were shipping Chocolatey packages for a time after Frontier, it has fallen out of date due to the constant manual approval process. With our new build infrastructure in place we will attempt to negotiate trusted package status for go-ethereum to be able to reinstate the Chocolatey workflow. Until then please grab a Windows installer from our [downloads](https://geth.ethereum.org/downloads) page.
```shell
pkg install go-ethereum
```
The `geth` command is then available on your system in `/usr/local/bin/geth`, you can start it e.g. on the testnet by typing:
```shell
geth -rinkeby
```
### Installing on FreeBSD Using ports
Go to the `net-p2p/go-ethereum` ports directory:
```shell
cd /usr/ports/net-p2p/go-ethereum
```
Then build it the standard way (as root):
```shell
make install
```
### Installing on Arch Linux using `pacman`
The `geth` package is available from the [community repo](https://www.archlinux.org/packages/community/x86_64/geth/).
You can install it using
```shell
pacman -S geth
```
## Download standalone bundle
@ -78,14 +133,15 @@ The image has the following ports automatically exposed:
* `8545` TCP, used by the HTTP based JSON RPC API
* `8546` TCP, used by the WebSocket based JSON RPC API
* `8547` TCP, used by the GraphQL API
* `30303` TCP and UDP, used by the P2P protocol running the network
* `30304` UDP, used by the P2P protocol's new peer discovery overlay
*Note, if you are running an Ethereum client inside a docker container, you might want to mount in a data volume as the client's data directory (located at `/root/.ethereum` inside the container) to ensure that downloaded data is preserved between restarts and/or container life-cycles.*
## Build it from source code
Go Ethereum (as its name implies) is written in [Go](https://golang.org), and as such to build from source code you'll need to ensure that you have at least Go 1.7 installed (preferably the latest version, currently at 1.9.2). This guide will not go into details on how to install Go itself, for that please consult the [Go installation instructions](https://golang.org/doc/install) and grab any needed bundles from the [Go download page](https://golang.org/dl/).
### Most Linux systems
Go Ethereum (as its name implies) is written in [Go](https://golang.org), and as such to build from source code you'll need to ensure that you have the most recent version of Go. This guide will not go into details on how to install Go itself, for that please consult the [Go installation instructions](https://golang.org/doc/install) and grab any needed bundles from the [Go download page](https://golang.org/dl/).
Assuming you have Go installed, you can download our project via:
@ -101,6 +157,44 @@ go install github.com/ethereum/go-ethereum/cmd/geth
Or you can also 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.
### MacOS
If you see some errors related to header files of Mac OS system library, install XCode Command Line Tools, and try again.
```shell
xcode-select --install
```
### FreeBSD
Ports are slightly more up to date (1.8.14 at the time of writing)
Clone the repository to a directory of your choosing:
```shell
git clone https://github.com/ethereum/go-ethereum
```
Building `geth` requires the Go compiler:
```shell
pkg install go
```
If your golang version is >= 1.5, build the `geth` program using the following command.
```shell
cd go-ethereum
make geth
```
If your golang version is < 1.5 (quarterly packages, for example), use the following command instead.
```shell
cd go-ethereum
CC=clang make geth
```
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 work spaces 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 will configure everything for a temporary build and clean up after itself:

16
docs/_install-and-build/Installing-Go.md
View File

@ -1,16 +0,0 @@
---
title: Installing Go
---
### Windows
Download and run the installer found at http://golang.org/doc/install
### OS X
Download an install the darwin binary from https://golang.org/dl/
You can also install go using the Homebrew package manager.
### Linux
See information about go-installation at [golang](https://golang.org/doc/install)

68
docs/_install-and-build/Running-in-Docker.md
View File

@ -1,68 +0,0 @@
---
title: Running in Docker
---
We keep a Docker image with recent snapshot builds from the `develop` branch [on DockerHub](https://hub.docker.com/r/ethereum/client-go/). In addition to the container based on [Ubuntu](http://www.ubuntu.com) (158 MB), there is a smaller image using [Alpine Linux](https://alpinelinux.org) (35 MB). To use the alpine [tag](https://hub.docker.com/r/ethereum/client-go/tags), replace `ethereum/client-go` with `ethereum/client-go:alpine` in the examples below.
To pull the image, run this command:
```shell
docker pull ethereum/client-go
```
Start a node with:
```shell
docker run -it -p 30303:30303 ethereum/client-go
```
To start a node that runs the JSON-RPC interface on port **8545**, run:
```shell
docker run -it -p 8545:8545 -p 30303:30303 ethereum/client-go --rpc --rpcaddr "0.0.0.0"
```
**WARNING: This opens your container to external calls. "0.0.0.0" should _not_ be used when exposed to public networks**
To use the interactive JavaScript console, run:
```shell
docker run -it -p 30303:30303 ethereum/client-go console
```
## Using Data Volumes
To persist downloaded blockchain data between container starts, use Docker [data volumes](https://docs.docker.com/engine/tutorials/dockervolumes/#/mount-a-host-directory-as-a-data-volume). Replace `/path/on/host` with the location you want to store the data in.
docker run -it -p 30303:30303 -v /path/on/host:/root/.ethereum ethereum/client-go
* * *
We maintain four different docker images for running the latest stable or development versions of Geth.
- `ethereum/client-go:latest` is the latest development version of Geth
- `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
<!-- TODO: What are these? Maybe best not in getting started -->
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 develop 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
<!-- TODO: Same again -->
The image has the following ports automatically exposed:
- `8545` TCP, used by the HTTP based JSON RPC API
- `8546` TCP, used by the WebSocket based JSON RPC API
- `30303` TCP and UDP, used by the P2P protocol running the network
- `30304` UDP, used by the P2P protocol's new peer discovery overlay
<!-- TODO: And again -->
_Note, if you are running an Ethereum client inside a docker container, you might want to mount in a data volume as the client's data directory (located at `/root/.ethereum` inside the container) to ensure that downloaded data is preserved between restarts and/or container life-cycles._