- ---
- order: 2
- ---
-
- # Quick Start
-
- ## Overview
-
- This is a quick start guide. If you have a vague idea about how Tendermint
- works and want to get started right away, continue.
-
- ## Install
-
- ### Quick Install
-
- To quickly get Tendermint installed on a fresh
- Ubuntu 16.04 machine, use [this script](https://git.io/fFfOR).
-
- > :warning: Do not copy scripts to run on your machine without knowing what they do.
-
- ```sh
- curl -L https://git.io/fFfOR | bash
- source ~/.profile
- ```
-
- The script is also used to facilitate cluster deployment below.
-
- ### Manual Install
-
- For manual installation, see the [install instructions](install.md)
-
- ## Initialization
-
- Running:
-
- ```sh
- tendermint init
- ```
-
- will create the required files for a single, local node.
-
- These files are found in `$HOME/.tendermint`:
-
- ```sh
- $ ls $HOME/.tendermint
-
- config data
-
- $ ls $HOME/.tendermint/config/
-
- config.toml genesis.json node_key.json priv_validator.json
- ```
-
- For a single, local node, no further configuration is required.
- Configuring a cluster is covered further below.
-
- ## Local Node
-
- Start Tendermint with a simple in-process application:
-
- ```sh
- tendermint start --proxy-app=kvstore
- ```
-
- > Note: `kvstore` is a non persistent app, if you would like to run an application with persistence run `--proxy-app=persistent_kvstore`
-
- and blocks will start to stream in:
-
- ```sh
- I[01-06|01:45:15.592] Executed block module=state height=1 validTxs=0 invalidTxs=0
- I[01-06|01:45:15.624] Committed state module=state height=1 txs=0 appHash=
- ```
-
- Check the status with:
-
- ```sh
- curl -s localhost:26657/status
- ```
-
- ### Sending Transactions
-
- With the KVstore app running, we can send transactions:
-
- ```sh
- curl -s 'localhost:26657/broadcast_tx_commit?tx="abcd"'
- ```
-
- and check that it worked with:
-
- ```sh
- curl -s 'localhost:26657/abci_query?data="abcd"'
- ```
-
- We can send transactions with a key and value too:
-
- ```sh
- curl -s 'localhost:26657/broadcast_tx_commit?tx="name=satoshi"'
- ```
-
- and query the key:
-
- ```sh
- curl -s 'localhost:26657/abci_query?data="name"'
- ```
-
- where the value is returned in hex.
-
- ## Cluster of Nodes
-
- First create four Ubuntu cloud machines. The following was tested on Digital
- Ocean Ubuntu 16.04 x64 (3GB/1CPU, 20GB SSD). We'll refer to their respective IP
- addresses below as IP1, IP2, IP3, IP4.
-
- Then, `ssh` into each machine, and execute [this script](https://git.io/fFfOR):
-
- ```sh
- curl -L https://git.io/fFfOR | bash
- source ~/.profile
- ```
-
- This will install `go` and other dependencies, get the Tendermint source code, then compile the `tendermint` binary.
-
- Next, use the `tendermint testnet` command to create four directories of config files (found in `./mytestnet`) and copy each directory to the relevant machine in the cloud, so that each machine has `$HOME/mytestnet/node[0-3]` directory.
-
- Before you can start the network, you'll need peers identifiers (IPs are not enough and can change). We'll refer to them as ID1, ID2, ID3, ID4.
-
- ```sh
- tendermint show_node_id --home ./mytestnet/node0
- tendermint show_node_id --home ./mytestnet/node1
- tendermint show_node_id --home ./mytestnet/node2
- tendermint show_node_id --home ./mytestnet/node3
- ```
-
- Finally, from each machine, run:
-
- ```sh
- tendermint start --home ./mytestnet/node0 --proxy-app=kvstore --p2p.persistent-peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
- tendermint start --home ./mytestnet/node1 --proxy-app=kvstore --p2p.persistent-peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
- tendermint start --home ./mytestnet/node2 --proxy-app=kvstore --p2p.persistent-peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
- tendermint start --home ./mytestnet/node3 --proxy-app=kvstore --p2p.persistent-peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
- ```
-
- Note that after the third node is started, blocks will start to stream in
- because >2/3 of validators (defined in the `genesis.json`) have come online.
- Persistent peers can also be specified in the `config.toml`. See [here](../tendermint-core/configuration.md) for more information about configuration options.
-
- Transactions can then be sent as covered in the single, local node example above.
|