Venus Docker 使用文档

快速部署

docker compose

可以通过 docker compose 在当前主机上，部署 venus 的一套云组件。

• 获取 compose 配置文件

git clone https://github.com/LinZexiao/venus-docker-compose.git -b v1.11
cd venus-docker-compose

• 设置 snapshot 文件路径 和 网络类型

下面以 calibration 网络为例子

vi chain.env

# * The path to you snapshot file
# Must be a absolute path
SNAP_SHOT=/path/to/your/snapshot.car

# * The net type you want to start
# Must be one of mainnet,2k,calibrationnet,interopnet,butterflynet,force, default is mainnet
NET_TYPE=calibrationnet

• 启动智子服务

make chain

云环境启动后会需要一定的时间进行初始化，初始化完成后，就可以使用 auth 组件签发 token（详细见 使用 章节），并将下游组件的连接到本主机即可。（另：集群中使用统一的 admin token 会导出在 ./.venus/env/ 中） 为了方便修改配置，默认会将容器中的 repo 映射到本地的 ./.venus/root/中，修改完配置之后直接重启容器即可

注意

在 miner 初始化完成之后要记得通过 auth 绑定到相应的用户，参见添加矿工 (opens new window)

注意

在 miner 初始化完成之后，需要将 miner 关联到 market，参见将 miner 的 Multiaddrs 和 PeerID 设置为 market 的对应地址 (opens new window)部分

单组件

适用于在不同主机上进行 venus 组件 docker 的部署，

Venus Auth

docker run -d --name venus-auth --net=host filvenus/venus-auth run

Venus

docker run -d --name venus --net=host -v /path/to/snapshot.car:/snapshot.car \
--env HTTPS_PROXY=<PROXY_IF_NEED> \
filvenus/venus daemon \
--network=<NETTYPE> \
--auth-url=<VENUS_AUTH_URL> \
--auth-token=<VENUS_AUTH_TOKEN>
--import-snapshot /snapshot.car 

Venus Gateway

docker run -d --name venus-gateway --net=host filvenus/venus-gateway \
--listen /ip4/0.0.0.0/tcp/45132 \
run --auth-url <http://VENUS_AUTH_IP_ADDRESS:PORT> \
--auth-token <venus-auth token>

Venus Messager

docker run -d  --name venus-messager  --net=host filvenus/venus-messager run \
--auth-url=<http://VENUS_AUTH_IP_ADDRESS:PORT> \
--node-url /ip4/<VENUS_DAEMON_IP_ADDRESS>/tcp/3453 \
--gateway-url=/ip4/<IP_ADDRESS_OF_VENUS_GATEWAY>/tcp/45132 \
--auth-token <SHARED_ADMIN_AUTH_TOKEN> 

Venus Miner

docker run -d  --name venus-miner --net=host filvenus/venus-miner init \
--auth-api <http://VENUS_AUTH_IP_ADDRESS:PORT> \
--token <SHARED_ADMIN_AUTH_TOKEN> \
--gateway-api /ip4/<VENUS_GATEWAY_IP_ADDRESS>/tcp/45132 \
--api /ip4/<VENUS_DAEMON_IP_ADDRESS>/tcp/3453 \
--slash-filter local

Venus Market

docker run -d --name venus-market --net=host \
-v </path/to/your/PieceStorage>:/PieceStorage
filvenus/venus-market  pool-run \
--node-url=/ip4/<VENUS_NODE_IP_ADDRESS>/tcp/3453  \
--auth-url=http://<VENUS_AUTH_IP_ADDRESS:PORT> \
--gateway-url=/ip4/<VENUS_GATEWAY_IP_ADDRESS>/tcp/45132 \
--messager-url=/ip4/<VENUS_MESSAGER_IP_ADDRESS>/tcp/39812/ \
--auth-token=<SHARED_ADMIN_AUTH_TOKEN>

Venus Wallet

docker run -d --name venus-market --net=host \
-v </path/to/your/PieceStorage>:/PieceStorage
filvenus/venus-market  pool-run \
--node-url=/ip4/<VENUS_NODE_IP_ADDRESS>/tcp/3453  \
--auth-url=http://<VENUS_AUTH_IP_ADDRESS:PORT> \
--gateway-url=/ip4/<VENUS_GATEWAY_IP_ADDRESS>/tcp/45132 \
--messager-url=/ip4/<VENUS_MESSAGER_IP_ADDRESS>/tcp/39812/ \
--auth-token=<SHARED_ADMIN_AUTH_TOKEN>

Docker 容器的使用

基本使用

所有组件都可以使用以下通用的命令格式进行调用，组件详细的子命令参见 组件详细文档，以及 --help flag

docker run -it <DOCKKER_NAME> /<VENUS_COMPONENT_NAME> [global options] command [command options] [arguments...]

举例

# Auth
docker exec -it filvenus/venus-auth ./venus-auth [global options] command [command options] [arguments...]

# Venus
docker exec -it filvenus/venus ./venus [global options] command [command options] [arguments...]

# Gateway
docker exec -it filvenus/venus-gateway ./venus-gateway [global options] command [command options] [arguments...]

# Messager
docker exec -it filvenus/venus-messager ./venus-messager [global options] command [command options] [arguments...]

# miner
docker exec -it filvenus/venus-miner [global options] command [command options] [arguments...]

提示

启动容器的方式不同，容器的名字也不一样，可以使用 docker container ls 来查看容器的名字，也可以在容器启动的时候自己指定容器的名字。

环境调整和配置文件

建议将配置文件映射到本地进行配置文件相关的配置，需要在启动容器的时候建立映射。

# venus 举例
docker run -d --name filvenus/venus --net=host \
-v /path/to/snapshot.car:/snapshot.car \
-v /path/to/config.json:/root/.venus/config.json  #配置文件映射
--env HTTPS_PROXY=<PROXY_IF_NEED> \
tanlang/venus \
--network=<NETTYPE> \
--auth-url=<VENUS_AUTH_URL> \
--auth-token=<VENUS_AUTH_TOKEN> \
--import-snapshot /snapshot.car 

如果需要进入容器修改配置文件或者调整组件运行环境的话：

docker exec -it filvenus/venus /bin/bash

自己开发构建镜像

组件的构建

任意组件的构建

在对应组件的根目录下执行 make docker 即可构建对应的组件镜像

```shell
# 到对应组件根目录
make docker
# 网络受限需要使用代理时
make docker BUILD_DOCKER_PROXY=<socks5 | https >://<IP>:<PORT>