add quick start guide by zramsay · Pull Request #1069 · tendermint/tendermint

zramsay · 2018-01-06T05:09:37Z

quick start guide for Tendermint
script for quick install on Ubuntu
default files for quick cluster creation

codecov-io · 2018-01-06T05:23:26Z

Codecov Report

Merging #1069 into develop will increase coverage by 0.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #1069      +/-   ##
===========================================
+ Coverage    59.94%   59.96%   +0.01%     
===========================================
  Files          116      116              
  Lines        10748    10748              
===========================================
+ Hits          6443     6445       +2     
  Misses        3724     3724              
+ Partials       581      579       -2

melekes · 2018-01-06T14:59:41Z

docs/examples/getting-started.md

+
+## Overview
+
+Tendermint is ...


do we need this section in getting started?

it's meant to be a one-liner filled in last. It's probably not needed but it's what was asked for

melekes · 2018-01-06T15:00:58Z

docs/examples/getting-started.md

+
+## Install
+
+Note: Quick Start on a fresh machine can be done with [this script](https://gist.githubusercontent.com/zramsay/4bca8907a97ad825c30cfdc6f72ba97b/raw/b94bf36e34181a2960f9fe0d3eff260d03b6064e/install_tendermint.sh); tested on Ubuntu 16.04. It is used in the cluster deployment below.


let's add a command to run

curl -L https://gist.githubusercontent.com/zramsay/4bca8907a97ad825c30cfdc6f72ba97b/raw/b94bf36e34181a2960f9fe0d3eff260d03b6064e/install_tendermint.sh | bash

or

curl -L https://git.io/vNTiV | bash

Note: this link will change to refer to the file currently being check-in with this PR, however, that file should point to master branch, so that can wait until release

melekes · 2018-01-06T15:03:18Z

docs/examples/getting-started.md

+- `go` minimum version 1.9.2
+- `$GOPATH` set and `$GOPATH/bin` on your $PATH (see https://github.com/tendermint/tendermint/wiki/Setting-GOPATH)
+
+To create the `tendermint` binary, run:


To install Tendermint, run ?

melekes · 2018-01-06T15:05:18Z

docs/examples/getting-started.md

+Then, `ssh` into each machine, and `curl` then execute [this script](https://gist.githubusercontent.com/zramsay/4bca8907a97ad825c30cfdc6f72ba97b/raw/b94bf36e34181a2960f9fe0d3eff260d03b6064e/install_tendermint.sh):
+
+```
+curl -o tmint.sh https://gist.githubusercontent.com/zramsay/4bca8907a97ad825c30cfdc6f72ba97b/raw/b94bf36e34181a2960f9fe0d3eff260d03b6064e/install_tendermint.sh


curl -L https://git.io/vNTiV | bash

melekes · 2018-01-06T15:09:32Z

docs/examples/install_tendermint.sh

+#!/usr/bin/env bash
+
+# get and unpack golang
+curl -O https://storage.googleapis.com/golang/go1.9.2.linux-amd64.tar.gz


this will not work for x86 and macOS... maybe we need an if OS == darwin

i know, that's explicit in this line https://github.com/tendermint/tendermint/pull/1069/files#diff-efa5271fdabd2250b8d2dd60cfc5ff1dR9

This script is meant explicitly for a Ubuntu on a DO box. I'll make it clearer in the script itself

melekes · 2018-01-06T15:11:09Z

docs/examples/install_tendermint.sh

+echo "export PATH=\$PATH:/usr/local/go/bin" >> ~/.profile
+
+## create the GOPATH directory, set GOPATH and put on PATH
+mkdir goApps


is this from official guides?

the official guide doesn't even set a $GOPATH, so no. AFAICT there is no standard for naming this directory (I've seen work, gocode, go, goApps etc, the list goes on)

melekes · 2018-01-06T15:12:13Z

docs/examples/install_tendermint.sh

+curl -O https://storage.googleapis.com/golang/go1.9.2.linux-amd64.tar.gz
+tar -xvf go1.9.2.linux-amd64.tar.gz
+
+apt install make


what if no apt? what about yum?

see previous comment. it's not meant a multi-OS check-all-the-things scripts, but rather as a quick and dirty get-started-ASAP-on-Digital-OCean

melekes · 2018-01-06T15:13:46Z

docs/examples/install_tendermint.sh

+cd $GOPATH/src/$REPO
+
+## build
+git checkout v0.15.0


maybe we need to check for git as well or install it above (apt-get install make git)

git is already instaled on Ubnutn 16.04

melekes · 2018-01-06T15:15:12Z

docs/examples/getting-started.md

+
+This will install `go` and other dependencies, get the Tendermint source code, then compile the `tendermint` binary.
+
+Next, `cd` into `docs/examples`. Each command below should be run from each node, in sequence:


Can't we just run tendermint node --home ./nodeN --proxy_app=dummy --p2p.seeds IP1:46656,IP2:46656,IP3:46656,IP4:46656 on each node?

sure but that's more text, and will lead to more Error can't connect to peer than otherwise

…dermint#1069) Bumps [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action) from 2.7.0 to 2.8.0. - [Release notes](https://github.com/docker/setup-buildx-action/releases) - [Commits](docker/setup-buildx-action@v2.7.0...v2.8.0) --- updated-dependencies: - dependency-name: docker/setup-buildx-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

zramsay added 4 commits January 6, 2018 03:31

default files to run a testnet

5c42f04

need dem genesis files

f2051ec

add quickstart

adbb870

couple more updates

b8f002e

zramsay requested review from ebuchman and melekes as code owners January 6, 2018 05:09

lil fixes

4ce13b9

melekes reviewed Jan 6, 2018

View reviewed changes

zramsay added 3 commits January 8, 2018 14:26

quick start examples: address anton's comments

239e2ef

breif intro

99660d6

Merge branch 'develop' into examples

97e3c29

melekes approved these changes Jan 9, 2018

View reviewed changes

Merge branch 'develop' into examples

a87f29a

zramsay merged commit c521f38 into develop Jan 9, 2018

zramsay deleted the examples branch January 9, 2018 20:35

zramsay added a commit that referenced this pull request Jan 10, 2018

add quick start guide (#1069)

76199a6

ebuchman pushed a commit that referenced this pull request Jan 20, 2018

add quick start guide (#1069)

8f590d6


		## Install

		Note: Quick Start on a fresh machine can be done with [this script](https://gist.githubusercontent.com/zramsay/4bca8907a97ad825c30cfdc6f72ba97b/raw/b94bf36e34181a2960f9fe0d3eff260d03b6064e/install_tendermint.sh); tested on Ubuntu 16.04. It is used in the cluster deployment below.


		This will install `go` and other dependencies, get the Tendermint source code, then compile the `tendermint` binary.

		Next, `cd` into `docs/examples`. Each command below should be run from each node, in sequence:

Conversation

zramsay commented Jan 6, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-io commented Jan 6, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zramsay Jan 8, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zramsay commented Jan 6, 2018 •

edited

Loading

codecov-io commented Jan 6, 2018 •

edited

Loading

zramsay Jan 8, 2018 •

edited

Loading