Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

R4R: Update docs #1933

Merged
merged 2 commits into from
Aug 30, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,12 @@ module.exports = {
['kms/kms.md', 'Kms']
],
'/get-started/': [
['Join-the-Testnet.md', 'Use the Testnet'],
['Join-the-Mainnet.md', 'Join the Mainnet'],
['Join-the-Mainnet.md', 'Mainnet'],
['Join-the-Testnet.md', 'Testnet'],
['Full-Node.md', 'Full Node'],
['Validator-Node.md', 'Validator Node']
['Validator-Node.md', 'Validator Node'],
['Wallets.md', 'Wallets'],
['Explorers.md', 'Explorers']
],
'/features/': [{
title: 'Basic Concepts',
Expand Down Expand Up @@ -193,10 +195,12 @@ module.exports = {
['kms/kms.md', 'Kms']
],
'/zh/get-started/': [
['Join-the-Testnet.md', '使用测试网'],
['Join-the-Mainnet.md', '加入主网'],
['Join-the-Mainnet.md', '主网'],
['Join-the-Testnet.md', '测试网'],
['Full-Node.md', '全节点'],
['Validator-Node.md', '验证人节点']
['Validator-Node.md', '验证人节点'],
['Wallets.md', '钱包'],
['Explorers.md', '浏览器']
],
'/zh/features/': [{
title: '基础概念',
Expand Down
2 changes: 1 addition & 1 deletion docs/features/asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Introduction

This specification describes asset managerment on IRISHub. Anyone could issue a new asset on IRISHub, or propose pegging an existing asset from any other blockchains via On-Chain Governance.
This specification describes asset management on IRISHub. Anyone could issue a new asset on IRISHub, or propose pegging an existing asset from any other blockchains via On-Chain Governance.

## Concepts

Expand Down
8 changes: 0 additions & 8 deletions docs/get-started/Download-Rainbow.md

This file was deleted.

10 changes: 10 additions & 0 deletions docs/get-started/Explorers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# IRISnet Explorers

These block explorers allow you to search, view and analyze IRIS Hub data—like blocks, transactions, validators, governance including params or proposals, etc.

- [IRISplorer](https://www.irisplorer.io/)
- [Big-Dipper](https://iris.bigdipper.live/)
- [IRISnet-P2P](https://irisnet.p2p.org/)
- [Hubble](https://hubble.figment.network/iris/chains/irishub)
- [Mintscan](https://irishub.mintscan.io/)
- [IRISnet-Overview](https://irisnet-overview.genesislab.net/)
4 changes: 2 additions & 2 deletions docs/get-started/Join-the-Mainnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ If you plan to use a KMS (key management system), you should go through these st

## Useful Links

* Riot chat: #irisvalidators:matrix.org
- Riot chat: #irisvalidators:matrix.org

* Explorer: https://www.irisplorer.io/#/home
- Explorer: <https://www.irisplorer.io>
8 changes: 8 additions & 0 deletions docs/get-started/Wallets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# IRISnet Wallets

These web and mobile wallets allow you to store & transfer IRIS, delegate IRIS to validators, and some of them also support ATOM. Note that we do not endorse any of the wallets, they are listed for your convenience.

- [Rainbow](https://www.rainbow.one/) (Android, iOS)
- [Math Wallet](http://www.mathwallet.org/en/) (Android, iOS)
- [Wetez](https://www.wetez.io/pc/homepage) (Android, iOS)
- [Cosmostation](https://www.cosmostation.io/) (Android, iOS)
82 changes: 28 additions & 54 deletions docs/software/How-to-install-irishub.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
# How to install `iris`

### The Latest version of IRIShub : v0.15.1
refer to : https://github.com/irisnet/irishub/releases/latest
```
Please replace <latest_iris_version> with v0.15.1 while using "git checkout"
```
## Latest Version

The Latest version of IRIShub is [v0.15.1](https://github.com/irisnet/irishub/releases/latest)

You can download the source code from github and compile it locally.
::: tip
Please replace <latest_iris_version> below with v0.15.1
:::

#### Configure Your Server
## Configure Your Server

It's recommended that you run a validator node on Linux Server.
It's recommended that you run irishub nodes on Linux Server.

**Recommended Configurations:**

1. 2 CPU
2. Memory: 6GB
3. Disk: 256GB SSD
4. OS: Ubuntu 16.04 LTS
5. Bandwidth: 20Mbps
6. Allow all incoming connections on TCP port 26656 and 26657
- 2 CPU
- Memory: 6GB
- Disk: 256GB SSD
- OS: Ubuntu 16.04 LTS +
- Bandwidth: 20Mbps
- Allow all incoming connections on TCP port 26656 and 26657

#### Install Go
## Install

### Install `go`

::: tip
**Go 1.12.5+** is required for the IRIShub.
Expand All @@ -33,56 +35,28 @@ Remember to set your `$GOPATH`, `$GOBIN`, and `$PATH` environment variables, for

```bash
mkdir -p $HOME/go/bin
echo "export GOPATH=$HOME/go" >> ~/.bash_profile
echo "export GOBIN=$GOPATH/bin" >> ~/.bash_profile
echo "export PATH=$PATH:$GOBIN" >> ~/.bash_profile
source ~/.bash_profile
echo "export GOPATH=$HOME/go" >> ~/.bashrc
echo "export GOBIN=$GOPATH/bin" >> ~/.bashrc
echo "export PATH=$PATH:$GOBIN" >> ~/.bashrc
source ~/.bashrc
```

Verify that Go has been installed successfully:
```bash
go version
```

::: tip
Quick install for macOS

Step 1: install `brew`

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Step 2: install `go` with `brew`

brew install go
:::

#### Compile Source Code

- Get the code and compile Iris
### Install `iris`

After setting up Go correctly, you should be able to compile and run `iris`.
Make sure that your server can access to google.com because our project depends on some libraries provided by google.

* To compile for `testnet`:
Please checkout the latest version,refer to:https://github.com/irisnet/irishub/releases/latest
```
mkdir -p $GOPATH/src/github.com/irisnet
cd $GOPATH/src/github.com/irisnet
git clone https://github.com/irisnet/irishub
cd irishub && git checkout <latest_iris_version>
make get_tools
source scripts/setTestEnv.sh
make all
```
Make sure that your server can access to google.com because our project depends on some libraries provided by google.

* To compile for `betanet`:
```
mkdir -p $GOPATH/src/github.com/irisnet
cd $GOPATH/src/github.com/irisnet
git clone https://github.com/irisnet/irishub
cd irishub && git checkout <latest_iris_version>
make get_tools
make all
```bash
git clone --branch <latest_iris_version> https://github.com/irisnet/irishub
cd irishub
# source scripts/setTestEnv.sh # used for installing the testnet version
make get_tools install
```

If your environment variables have set up correctly, you should not get any errors by running the above commands.
Expand Down
7 changes: 0 additions & 7 deletions docs/zh/get-started/Download-Rainbow.md

This file was deleted.

10 changes: 10 additions & 0 deletions docs/zh/get-started/Explorers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# IRISnet 浏览器

您可通过以上区块链浏览器查询和分析 IRIS Hub 的区块、交易、验证人等信息。

- [IRISplorer](https://www.irisplorer.io/)
- [Big-Dipper](https://iris.bigdipper.live/)
- [IRISnet-P2P](https://irisnet.p2p.org/)
- [Hubble](https://hubble.figment.network/iris/chains/irishub)
- [Mintscan](https://irishub.mintscan.io/)
- [IRISnet-Overview](https://irisnet-overview.genesislab.net/)
2 changes: 1 addition & 1 deletion docs/zh/get-started/Join-the-Mainnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ IRIS Hub是在Cosmos生态中的区域性枢纽,提供iService服务
## 更多链接


* Explorer: https://www.irisplorer.io/#/home
* Explorer: <https://www.irisplorer.io>

* Riot chat: #irisvalidators:matrix.org

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/get-started/Validator-Node.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ blast change tumble toddler rival ordinary chicken dirt physical club few langua
```
iriscli keys add <key_name> --recover
```
### 获得IRIS代币(仅限Testnet 测试网)
### 获得IRIS代币(仅限 Fuxi Testnet 测试网)


一旦你完成了账户的创建,你可以通过[水龙头](https://testnet.irisplorer.io/#/faucet)获得用于测试网的IRIS token,然后你就可以将这部分IRIS用于绑定成为验证人。
Expand Down
8 changes: 8 additions & 0 deletions docs/zh/get-started/Wallets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# IRISnet 钱包

这些钱包支持IRIS及ATOM的转账和质押,请充分研究其安全性再使用。列示这些信息仅为方便下载,并不代表对钱包使用的安全性负责。

- [Rainbow](https://www.rainbow.one/) (Android, iOS)
- [Math Wallet](http://www.mathwallet.org/en/) (Android, iOS)
- [Wetez](https://www.wetez.io/pc/homepage) (Android, iOS)
- [Cosmostation](https://www.cosmostation.io/) (Android, iOS)
84 changes: 29 additions & 55 deletions docs/zh/software/How-to-install-irishub.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# 如何安装`iris`

### 当前IRIShub最新版本为: v0.15.1
获取最新版本 https://github.com/irisnet/irishub/releases/latest
```
注意:使用 git checkout 命令时,请将 <latest_iris_version> 替换成 v0.15.1
```
## 最新版本

当前IRIShub最新版本为 [v0.15.1](https://github.com/irisnet/irishub/releases/latest)

### 源码编译安装
::: tip
请将下文中的 <latest_iris_version> 替换为 v0.15.1
:::

#### 服务器配置要求
## 服务器配置要求

首先,你需要配置一台服务器。验证人节点要求一直稳定运行,所以你需要在一台数据中心的服务器上部署IRIShub。任何像AWS、GCP、DigitalOcean中的云服务器都是适合的。

IRIShub是用Go语言编写的。它可以在任何能够编译并运行Go语言程序的平台上工作。然而,强烈建议在Linux服务器上运行验证人节点。
推荐的服务器的配置:
**推荐的服务器的配置:**

* CPU核数:2
* 内存容量:6GB
* 磁盘空间:256GB SSD
* 操作系统:Ubuntu 18.04 LTS/16.04 LTS
* 带宽: 20Mbps
* 允许的入方向的链接:TCP端口 26656 和 26657
- CPU核数:2
- 内存容量:6GB
- 磁盘空间:256GB SSD
- 操作系统:Ubuntu 16.04 LTS +
- 带宽: 20Mbps
- 允许的入方向的链接:TCP端口 26656 和 26657

## 安装

#### 安装Go
### 安装 `go`

::: tip
IRIShub需要 **Go 1.12.5+**.
Expand All @@ -32,60 +32,34 @@ IRIShub需要 **Go 1.12.5+**.
参照[官方文档](https://golang.org/doc/install)安装 `go`。

记住要设置 `$GOPATH`,`$GOBIN` 和 `$PATH` 环境变量,示例:

```bash
mkdir -p $HOME/go/bin
echo "export GOPATH=$HOME/go" >> ~/.bash_profile
echo "export GOBIN=$GOPATH/bin" >> ~/.bash_profile
echo "export PATH=$PATH:$GOBIN" >> ~/.bash_profile
source ~/.bash_profile
echo "export GOPATH=$HOME/go" >> ~/.bashrc
echo "export GOBIN=$GOPATH/bin" >> ~/.bashrc
echo "export PATH=$PATH:$GOBIN" >> ~/.bashrc
source ~/.bashrc
```

确认Go是否安装成功:
```bash
go version
```

::: tip
macOS 快速安装GO

Step 1: 安装 `brew`

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Step 2: 使用 `brew` 安装GO
### 安装 `iris`

brew install go
:::

#### 下载源码并安装

在完成Go的安装后,通过以下命令下载并安装IRIS hub相关程序.(请确保你的电脑可以访问`google.com`, `iris`很多库的依赖由google提供)

* 编译用于`测试网`的可执行文件:
请下载最新版本的代码编译,参考:https://github.com/irisnet/irishub/releases/latest
```
mkdir -p $GOPATH/src/github.com/irisnet
cd $GOPATH/src/github.com/irisnet
git clone https://github.com/irisnet/irishub
cd irishub && git checkout <latest_iris_version>
make get_tools
source scripts/setTestEnv.sh
make all
```
在完成Go的安装后,通过以下命令下载并安装IRIShub相关程序.(请确保你的电脑可以访问`google.com`, `iris`很多库的依赖由google提供)

* 编译用于`betanet`的可执行文件:
```
mkdir -p $GOPATH/src/github.com/irisnet
cd $GOPATH/src/github.com/irisnet
git clone https://github.com/irisnet/irishub
cd irishub && git checkout <latest_iris_version>
make get_tools
make all
```bash
git clone --branch <latest_iris_version> https://github.com/irisnet/irishub
cd irishub
# source scripts/setTestEnv.sh # 若参与测试网请执行此命令
make get_tools install
```

以上命令将完成`iris`和`iriscli`的安装. 若出现对应的版本号则说明安装成功。

```
```bash
$ iris version
<latest_iris_version>

Expand Down