Skip to content

Commit 56bd86b

Browse files
author
HenryLee
committed
完善文档
1.完善文档 2.修复编辑失误导致的脚本错误
1 parent c305404 commit 56bd86b

File tree

2 files changed

+51
-5
lines changed

2 files changed

+51
-5
lines changed

README.md

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,60 @@ VshareCloud-CLI
66
### 运行环境需求
77
- 2Core CPU以上
88
- 4GiB Ram以上 (实测2GiB Ram也可运行,但是性能不会很好)
9+
- 确保机器有充足的磁盘空间缓存IPFS数据块文件;即空闲空间至少要大于被储存文件的大小。
910
- 支持Systemd的Linux系统
1011
### 安装
11-
- 安装Rust
12+
- 1.安装Rust
1213
```
1314
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
1415
```
15-
- 执行安装
16+
- 2.主要组件安装
1617
```
18+
wget --no-check-certificate https://gateway.ipns.tech/ipns/vsharecloud-tools-install.ipns.network/install.sh -O install.sh && bash install.sh
19+
```
20+
- 以上脚本将在您的机器内安装:
21+
- IPFS Node | IPFS节点程序
22+
- Lotus-Lite | FileCoin客户端
23+
- VshareCloudTools | VshareCloud 工具组件
24+
- 3.配置Lotus钱包
25+
- 如果您有自己的FIL钱包秘钥,使用以下方式导入现有的FIL秘钥到节点内
26+
- 写入您的秘钥到一个纯文本文件内,例如 key.txt
27+
- 上传 key.txt 到服务器内
28+
- 执行 `lotus wallet import key.txt` 导入钱包,然后执行 `lotus wallet set-default <钱包地址>` 将您导入的钱包设定为默认钱包
29+
- 如果您没有自己的FIL钱包,请:
30+
- 执行 `lotus wallet new` 生成新的钱包
31+
- 执行 `lotus wallet list` 查看新的钱包地址
32+
- 在发起交易前,请确保该节点内的钱包具有足够的FIL余额来进行交易
33+
- 导出钱包秘钥的方法是 `lotus wallet export >> key.txt`
34+
- 4.开始储存交易
35+
```
36+
root@devmachine:~# vsharecloud-cli
37+
1.托管数据至VshareCloud #托管数据到VshareCloud联盟的FileCoin节点[*]
38+
2.托管数据到自定义FileCoin节点 #自定义托管节点
39+
3.托管数据到全球FileCoin节点(性价比最高,但是交易成功率与数据可靠性未知)#从整个网络内匹配价格最优的节点
40+
请选择交易类型(输入纯数字):
41+
```
42+
### 注意事项
43+
1.所有的上链数据都是面向整个网络公开的,如果您用于储存重要的数据,请先将内容进行加密打包后再储存
44+
2.储存交易对于数据大小有一定的要求,建议单笔数据存储交易的数据大小不小于16MiB且不大于60GiB,否则可能不会被接受
45+
3.储存后请自己保存好文件的CID和订单号等信息,便于后续取回数据
46+
47+
#### *关于VshareCloud联盟
48+
VshareCloud联盟是由本项目发起方组织的节点联盟,优势如下:
49+
- 我们对联盟内的节点进行了审核,确保服务商技术方案稳定可靠
50+
- 我们采用了动态稳定定价机制,确保所有节点的交易储存价格始终稳定在 0.01CNY/GiB/月 附近(后续根据全网资源,可能会有所微调)
51+
- 节点优化了接单接口的全球可达性,节点具备全球接单能力的同时,也具备了全球范围内的快速数据取回
1752

18-
```
53+
当您使用本工具进行数据存储并选择托管到VshareCloud节点(选项1)时,将会为您快速地匹配联盟内的节点,进行稳定高效的数据存储。
54+
55+
另外,如果有FileCoin节点运营商有意向加入我们的联盟,我们表示很欢迎,详情请加入社区Telegram群组后联系我们~
56+
57+
### 数据取回
58+
- 1.执行 `lotus client list-deals` 查询交易ID和FileCoin节点ID(即矿工号)
59+
- 复制f0开头的矿工号
60+
- 找出需要取回的CID
61+
- 2.进行数据取回
62+
```
63+
lotus client retrieve --miner <节点ID> <数据CID> /path/to/save
64+
```
65+
等候数据取回即可,取回操作会收取费用

Shell-Script/install.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,8 @@ if [ -e /usr/local/bin/lotus ]; then
152152
rm -rf /opt/vsharecloud-tools/
153153
fi
154154
mkdir /opt/vsharecloud-tools
155-
ipfs get /ipns/vsharecloud-tools.ipns.network/ -o c
155+
ipfs get /ipns/vsharecloud-tools.ipns.network/ -o /opt/vsharecloud-tools/
156156
chmod +x /opt/vsharecloud-tools/main.py
157157
sudo ln -s /opt/vsharecloud-tools/main.py /usr/bin/vsharecloud-cli
158158
OUT_INFO "[信息] 安装已完成!"
159-
160159
exit 0

0 commit comments

Comments
 (0)