README-zh.md

🦑 Nexus

IPFS网络节点编排协调工具

Nexus是 IPFS私有网络的节点编排，与Temporal服务注册的工具。Nexus可以为您提供按需部署、资源管理、元数据持久化，以容器Docker方式运行IPFS节点等细粒度功能。

多语言

安装和使用

$> go get -u github.com/RTradeLtd/Nexus/cmd/nexus

发布版本下载：Releases 。使用默认配置，运行Nexus的守护进程：

$> nexus init
$> nexus daemon

可以通过nexus -help命令获得更多使用说明帮助，配置文档生成init命令可以在 configuration 源码中找到。

开发

项目环境要求 Docker CE 以及不低于Go 1.11 版本。

可以克隆此仓库或者使用go get来获取基础代码:

$> go get github.com/RTradeLtd/Nexus

开发者也可以直接使用make命令进行构建

$> make   # installs dependencies and builds a binary

测试

执行测试脚本的时候，请确保docker环境已经运行

$> make test

之后，可以使用make clean命令删除剩余资产。

本地运行

使用下面一些make命令可以轻松模拟机器上的编排环境：

$> make dev-config # make sure dev configuration is up to date
$> make testenv    # initialize test environment
$> make daemon     # start up daemon with dev configuration

然后，你可以启动一个网络节点：

$> make new-network   # create network entry in database
$> make start-network # spin up network node

ctl

目前仍处于实验性质的轻量gRPC API控制器可通过以下执行nexus ctl方式获得，依赖以公开客户端 ctl的形式暴露。

$> nexus ctl help
$> nexus -dev ctl StartNetwork Network=test-network
$> nexus -dev ctl NetworkStats Network=test-network
$> nexus -dev ctl StopNetwork Network=test-network