Merge pull request #426 from ipfs-force-community/doc/update-docs-abo…

…ut-unit-entry doc: update doc about unit entry
ipfs-force-community · Sep 7, 2023 · 55c2838 · 55c2838
2 parents 55dc542 + 9894c09
commit 55c2838
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 26 deletions.
diff --git a/docs/zh/droplet配置解释.md b/docs/zh/droplet配置解释.md
@@ -10,6 +10,9 @@
 - 包括：同步节点，消息节点，签名节点及授权节点。
 
 ```toml
+[ChainService]
+  Url =  "/ip4/192.168.200.21/tcp/45132"
+  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiemwiLCJwZXJtIjoiYWRtaW4iLCJleHQiOiIifQ.3u-PInSUmX-8f6Z971M7JBCHYgFVQrvwUjJfFY03ouQ"
 [Node]
   Url = "/ip4/192.168.200.21/tcp/3453"
   Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiemwiLCJwZXJtIjoiYWRtaW4iLCJleHQiOiIifQ.3u-PInSUmX-8f6Z971M7JBCHYgFVQrvwUjJfFY03ouQ"
@@ -200,6 +203,10 @@ SimultaneousTransfersForRetrieval = 20
 
 
 # ****** venus 组件服务配置 ********
+[ChainService]
+  Url =  "/ip4/192.168.200.21/tcp/45132"
+  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiemwiLCJwZXJtIjoiYWRtaW4iLCJleHQiOiIifQ.3u-PInSUmX-8f6Z971M7JBCHYgFVQrvwUjJfFY03ouQ"
+
 [Node]
   Url = "/ip4/192.168.200.151/tcp/3453"
   Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoidGVzdC11c2VyMDEiLCJwZXJtIjoic2lnbiIsImV4dCI6IiJ9.ETjNy3HMDS3ScZ3cax9xYb6AopNWYp4y71lZGCvYxMg"
@@ -448,8 +455,18 @@ PrivateKey = "08011240ae580daabbe087007d2b4db4e880af10d582215d2272669a94c49c854f
 
 当 `droplet` 接入venus组件使用时，需要配置相关组件的API。
 
+
+#### [ChainService]
+venus 链服务统一入口配置。
+该配置项的 `Url` 和 `Token` 会成为后续配置项 `Node` , `Messager` 以及 `AuthNode` 的默认值
+```toml
+[ChainService]
+  Url =  "/ip4/192.168.200.21/tcp/45132"
+  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiemwiLCJwZXJtIjoiYWRtaW4iLCJleHQiOiIifQ.3u-PInSUmX-8f6Z971M7JBCHYgFVQrvwUjJfFY03ouQ"
+```
+
 #### [Node]
-venus链服务接入配置
+venus链同步节点接入配置
 ```
 [Node]
 # 链服务的入口

diff --git a/docs/zh/快速启用.md b/docs/zh/快速启用.md
@@ -42,40 +42,69 @@
 #### gateway签名模式
 
 `sophon-gateway`作为中转，会找链接`sophon-gateway`的wallet进行签名。
-作为链服务中的一个组件，配合`sophon-auth`、`venus`、 `sophon-messager`、`sophon-gateway`等组件一起为注册到链服务的 `miner` 提供市场服务。
+配合`sophon-auth`、`venus`、 `sophon-messager`、`sophon-gateway`等链服务组件一起为注册到链服务的 `miner` 提供市场服务。
 
+```sh
+./droplet run \
+--cs-url=/ip4/<ip>/tcp/<port> \
+--cs-token=<shared-token> \
+--signer-type="gateway" \
+--gateway-url=/ip4/<ip>/tcp/<port>
+```
+
+生成的服务组件配置参考:
+```toml
+[ChainService]
+  Url =  "/ip4/192.168.200.21/tcp/45132"
+  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiemwiLCJwZXJtIjoiYWRtaW4iLCJleHQiOiIifQ.3u-PInSUmX-8f6Z971M7JBCHYgFVQrvwUjJfFY03ouQ"
+
+[Signer]
+  Type = "gateway"
+  Url = "/ip4/127.0.0.1/tcp/45132"
+  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2hhcmVkLXRva2VuIiwicGVybSI6ImFkbWluIiwiZXh0IjoiIn0.aARqJ_7FSe1KakkBhWlFvsYm-xBLAXBnl9SvTfqsVe8"
 ```
+
+:tipping_hand_woman: **`shared-token` 是用于访问其他链服务组件 `API` 时的权限验证，由 `sophon-auth` 管理，需要 `admin` 权限。具体请参考 [sophon-auth token](https://github.com/filecoin-project/venus-docs/blob/master/docs/zh/cs/deploy-a-cs.md#user及token生成)**
+
+:tipping_hand_woman: **如果链服务组件没有[设置统一的入口](https://github.com/ipfs-force-community/sophon-gateway/blob/master/docs/zh/%E5%BF%AB%E9%80%9F%E5%90%AF%E7%94%A8.md#%E4%BD%BF%E7%94%A8-gateway-%E4%BB%A3%E7%90%86%E5%AF%B9%E5%85%B6%E4%BB%96%E7%BA%BF%E4%B8%8A%E7%BB%84%E4%BB%B6%E7%9A%84%E8%AF%B7%E6%B1%82)的话，可以配置文件或者通过命令行 flag 单独设置每一个链服务组件的 Url 和 Token 。具体请参考 [sophon-auth token](https://github.com/filecoin-project/venus-docs/blob/master/docs/zh/cs/deploy-a-cs.md#user及token生成)**
+
+##### 单独为每个链服务组件设置 Url 和 Token
+
+```sh
 ./droplet run \
---node-url=/ip4/<ip>/tcp/<port> \
 --auth-url=http://<ip>:<port> \
---gateway-url=/ip4/<ip>/tcp/<port> \
+--node-url=/ip4/<ip>/tcp/<port> \
 --messager-url=/ip4/<ip>/tcp/<port> \
 --cs-token=<shared-token> \
---signer-type="gateway"
+--signer-type="gateway" \
+--gateway-url=/ip4/<ip>/tcp/<port>
 ```
 
+
 生成的服务组件配置参考:
 ```toml
+[ChainService]
+  Url =  ""
+  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiemwiLCJwZXJtIjoiYWRtaW4iLCJleHQiOiIifQ.3u-PInSUmX-8f6Z971M7JBCHYgFVQrvwUjJfFY03ouQ"
 [Node]
   Url = "/ip4/192.168.200.151/tcp/3455"
-  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2hhcmVkLXRva2VuIiwicGVybSI6ImFkbWluIiwiZXh0IjoiIn0.aARqJ_7FSe1KakkBhWlFvsYm-xBLAXBnl9SvTfqsVe8"
+  Token = ""
 
 [Messager]
   Url = "/ip4/127.0.0.1/tcp/39812"
-  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2hhcmVkLXRva2VuIiwicGVybSI6ImFkbWluIiwiZXh0IjoiIn0.aARqJ_7FSe1KakkBhWlFvsYm-xBLAXBnl9SvTfqsVe8"
+  Token = ""
+
+[AuthNode]
+  Url = "http://127.0.0.1:8989"
+  Token = ""
 
 [Signer]
   Type = "gateway"
   Url = "/ip4/127.0.0.1/tcp/45132"
   Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2hhcmVkLXRva2VuIiwicGVybSI6ImFkbWluIiwiZXh0IjoiIn0.aARqJ_7FSe1KakkBhWlFvsYm-xBLAXBnl9SvTfqsVe8"
 
-[AuthNode]
-  Url = "http://127.0.0.1:8989"
-  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2hhcmVkLXRva2VuIiwicGVybSI6ImFkbWluIiwiZXh0IjoiIn0.aARqJ_7FSe1KakkBhWlFvsYm-xBLAXBnl9SvTfqsVe8"
 ```
 
-:tipping_hand_woman: **`shared-token` 是用于访问其他链服务组件 `API` 时的权限验证，由 `sophon-auth` 管理，需要 `admin` 权限。具体请参考 [sophon-auth token](https://github.com/filecoin-project/venus-docs/blob/master/docs/zh/cs/deploy-a-cs.md#user及token生成)**
-
 
 #### `venus-wallet` 签名模式
 
@@ -92,25 +121,18 @@ $ ./venus-wallet auth api-info --perm=sign
 
 ```
 ./droplet run \
---node-url=/ip4/<ip>/tcp/<port> \
---messager-url=/ip4/<ip>/tcp/<port> \
---cs-token=<token of write-authority that created by sophon-auth> \
+--cs-url=/ip4/<ip>/tcp/<port> \
+--cs-token=<shared-token> \
+--signer-type="wallet" \
 --signer-url=/ip4/<ip>/tcp/<port> \
---signer-token=<token of venus-wallet> \
---signer-type="wallet"
+--signer-token=<token of venus-wallet> 
 ```
 
 生成的服务组件配置参考:
 ```toml
-[Node]
-  Url = "/ip4/192.168.200.151/tcp/3455"
-  # sophon-auth生成的token
-  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2hhcmVkLXRva2VuIiwicGVybSI6ImFkbWluIiwiZXh0IjoiIn0.aARqJ_7FSe1KakkBhWlFvsYm-xBLAXBnl9SvTfqsVe8"
-
-[Messager]
-  Url = "/ip4/127.0.0.1/tcp/39812"
-  # sophon-auth生成的token
-  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoic2hhcmVkLXRva2VuIiwicGVybSI6ImFkbWluIiwiZXh0IjoiIn0.aARqJ_7FSe1KakkBhWlFvsYm-xBLAXBnl9SvTfqsVe8"
+[ChainService]
+  Url =  "/ip4/192.168.200.21/tcp/45132"
+  Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiemwiLCJwZXJtIjoiYWRtaW4iLCJleHQiOiIifQ.3u-PInSUmX-8f6Z971M7JBCHYgFVQrvwUjJfFY03ouQ"
 
 [Signer]
   Type = "wallet"