IPFS使用入门: 从安装到基本用法
在冰雪中的玫瑰
发表于 2022-12-18 20:38:51
164
0
0
9 G( F% Q0 [8 k
要使用IPFS, 第一步肯定是先把IPFS安装好,IPFS在Mac OS X 、Linux及Window平台均有提供, 可以通过这个链接下载对应平台可执行文件的压缩包。/ X8 p1 r8 h# D7 O+ {* z
4 p0 [* Y/ ]$ J" `) k& C' W
对于Mac OS X 及 Linux 平台,使用一下命令进行安装:( d u% B o& V% o
5 d' J7 ~/ D; M* T& |
$ tar xvfz go-ipfs.tar.gz
$ cd go-ipfs
$ ./install.sh/ t& A7 }9 _/ Z6 M4 e8 y
8 S* O+ Y& Q" L
上面先使用tar 对压缩包进行解压,然后执行install.sh 进行安装,安装脚本install.sh其实就是把可执行文件ipfs移动到$PATH目录下。安装完成之后,可以在命令行终端敲入ipfs试试看,如果显示一堆命令说明,则说明IPFS安装成功。
) e% U! }0 B& s" t5 Y, y2 o {' c
在Windows平台也是类似,把ipfs.exe移动到环境变量%PATH%指定的目录下。* Q7 L1 m. S# I' x+ G7 {
; E+ @4 p( q- G5 {8 a/ h
IPFS 基本用法
0 r& f5 \. g- K) A7 k, \& G
IPFS初始化
( l$ @1 |! C, ]( U& f9 y- o0 U$ m5 @
安装完成之后,要使用IPFS第一步是要对IPFS进行初始化,使用ipfs init进行初始化
> ipfs init0 c* f) w0 d) a4 |% c& ]
( i: r; c+ Q% d8 `
initializing ipfs node at /Users/Emmett/.ipfs& t, y; I! c8 I5 a% K
, z$ d; t$ w- r6 J
generating 2048-bit RSA keypair...done8 ^; w) O o4 ^- K0 e
peer identity: QmYM36s4ut2TiufVvVUABSVWmx8VvmDU7xKUiVeswBuTva
to get started, enter:
1 q+ l% _# ]; [) H0 H
ipfs cat /ipfs/QmS4ustL54uo8FzR9455qaxZwuMiUhyvMcX9Ba8nUH4uVv/readme
: a) S% `! @* A- T% A
上面是执行命令即对应输出,在执行ipfs init进行初始化时,会有一下行为:& @) H* y* j) E' p, X" Z8 N
$ q* u8 Z; |9 P
生成一个秘钥对并产生对应的节点id, 即命令提示:peer identity后面的hash值。4 O& A3 _* X( f" V5 g1 n
节点的id用来标识和连接一个节点,每个节点的id是独一无二的, 因此大家看到的提示也会和我的不一样。
在当前用户的主目录(~ 目录)下产生一个.ipfs 的隐藏目录,这个目录称之为库(repository)目录,ipfs 所有相关的数据都会放在这个目录下。
如同步文件数据块放在.ipfs/blocks 目录,秘钥在.ipfs/keystore 目录,ipfs配置文件为:.ipfs/config。5 |: Y6 \- ^9 H6 l1 E; _
& C5 L/ `; [. v& T# p8 \0 C% b3 z- o+ a
IPFS 配置修改
" r: s0 v) E' ^8 w6 u3 p9 m
在IPFS初始化之后,可以根据需要修改配置(可选),修改方法如下:7 A s: V: q9 {
! p* f/ O/ M( x5 P9 ~
cd ~/.ipfs
export EDITOR=/usr/bin/vim g7 I3 G' c8 d6 _4 m6 q% ?) N6 E
ipfs config edit) S2 t6 F* G* T* Q6 a
0 \) D7 A" a. [" D7 o: a
或者直接编辑 ~/.ipfs/config 文件。+ E8 }1 P& `3 l7 j" x5 I
上传文件到IPFS
6 d# I3 s7 {- C! L+ @* \ j- \! _
我们先创建一个upchain.pro.txt文件,可以使用如下方式:. X6 D7 f0 s! `2 ~2 Z0 S, V0 A y
% W( t9 z" Q: @! j, Y
> echo "比特池塘:www.bitmere.com" >> upchain.pro.txt
ipfs 使用add 命令来添加内容到节点中, 在命令行输入:
> ipfs add upchain.pro.txt' H5 y) C% D7 |$ D
added QmQgMZKqHzyEdyJja5ioF8WaXrbUDVjqhJDoaUKDymgioi upchain.pro.txt
) }- h( G6 o, \/ |0 n
43 B / 43 B [=====================================================] 100%; G) x U( Q5 c5 a
当它文件添加到节点时,会为文件生成唯一的hash: QmQgMZKqHzyEdyJja5ioF8WaXrbUDVjqhJDoaUKDymgioi, 可以使用ipfs cat 查看文件的内容: @1 b( {! ]) J+ Z: {; Z
> ipfs cat QmQgMZKqHzyEdyJja5ioF8WaXrbUDVjqhJDoaUKDymgioi* ~* ?- Q# \/ z3 U
注意,此时文件仅仅是上传在本地的IPFS节点中,如果需要把文件同步到网络,就需要开启 daemon 服务, 使用命令:
2 g$ k8 W$ z& N; w& B( z
> ipfs daemon% A4 I5 p6 P! `& W W
; P2 H& z' N1 ~2 N" V% ?
Initializing daemon...
go-ipfs version: 0.4.18-2 z0 X: C$ z( K/ m! Z9 ]
Repo version: 7' `9 D; g- O# s% f, x
% S! ~+ b9 p2 }( I
System version: amd64/darwin4 W! J: T! t/ u" k$ C" R4 i
Golang version: go1.11.18 R8 i& t- w: { ]0 d6 B
Swarm listening on /ip4/127.0.0.1/tcp/4001
Swarm listening on /ip4/192.168.8.105/tcp/40018 S* K4 B9 V6 `! f; A
Swarm listening on /ip6/2408:84f3:82e:cfcd:409:fee2:e261:4dc3/tcp/4001
Swarm listening on /ip6/2408:84f3:82e:cfcd:a9c6:116b:349f:8c2b/tcp/4001
Swarm listening on /ip6/2408:84f3:82e:cfcd:ec89:145d:cf27:4/tcp/4001
9 W6 K- Y0 W1 A& w# |9 Y$ q
Swarm listening on /ip6/::1/tcp/4001 q; I2 e) C1 W" @
) f5 ~$ ?% }; G! D8 \ X
Swarm listening on /ip6/fd1d:43b:e89b:eb9b:c405:56af:8f52:67df/tcp/4001
; E( Z) S' O) y& `& I; T" c
Swarm listening on /p2p-circuit
Swarm announcing /ip4/127.0.0.1/tcp/40010 A: {/ d% T8 @1 e; G
6 ]4 k T6 S/ {8 o0 o4 w+ U8 N6 K
Swarm announcing /ip4/192.168.8.105/tcp/40015 U" h' I. g5 F/ R8 S
9 w# j+ h, {9 a. ?; V
Swarm announcing /ip6/2408:84f3:82e:cfcd:409:fee2:e261:4dc3/tcp/4001& V7 X( G9 _/ Y8 q" J4 C" `
4 w1 E5 B3 A2 \$ I$ d
Swarm announcing /ip6/2408:84f3:82e:cfcd:a9c6:116b:349f:8c2b/tcp/4001" B; d) c4 W W* Q! z! G4 N
Swarm announcing /ip6/2408:84f3:82e:cfcd:ec89:145d:cf27:4/tcp/4001+ s" U4 F5 x0 f1 F+ O
, [+ v8 x) o1 |, m1 x
Swarm announcing /ip6/::1/tcp/4001
1 H' N5 k' q2 q
Swarm announcing /ip6/fd1d:43b:e89b:eb9b:c405:56af:8f52:67df/tcp/4001
API server listening on /ip4/127.0.0.1/tcp/5001
Gateway (readonly) server listening on /ip4/127.0.0.1/tcp/8080
% n0 Z' b! Q7 _, W9 X$ C9 ]& y' r( h
Daemon is ready
开启 daemon 之后,Swarm 就会尝试连接其他的节点,同步数据,同时在本地还会开启两个服务:API服务及Web网关服务,下面分别介绍下:
API服务,默认在5001端口,可以通过 http://localhost:5001/webui 进行访问,界面如:3 k5 ?& X; M1 G }3 x1 ^5 V
这也是IPFS的一个Web版的管理控制台, 可以通过这个控制台添加文件,查看节点连接情况等等。
6 J( i, d1 G: [7 o4 d' }2 O
网关服务,默认在8080端口, 由于当前浏览器还不支持通过IPFS协议(ipfs://)来访问文件,如果我们要在浏览器里访问文件的话,就需要借助于IPFS 提供的网关服务,由浏览器先访问到网关,网关去获取IPFS网络杀过了的文件。 有了网关服务,就可以通过这个链接:http://localhost:8080/ipfs/QmQgMZKqHzyEdyJja5ioF8WaXrbUDVjqhJDoaUKDymgioi 来访问刚刚上传到ipfs 的文件。
ipfs 也提供了官方的网关服务:https://ipfs.io/, 因此也可以通过 https://ipfs.io/ipfs/QmQgMZKqHzy ... UDVjqhJDoaUKDymgioi (需要翻墙)来访问刚刚上传到ipfs 的文件。
上传目录到IPFS
我们先创建一个文件夹upchain, 并把之前的 upchain.pro.txt 放进目录。) X- C* E' z6 V/ j8 g
> mkdir upchain* r! i% _; ~1 f2 c3 Q
7 F ]& n6 ^0 u; Z: S$ ]% `
> mv upchain.pro.txt upchain
n2 F; h9 w0 F! Y( |; R0 O; k4 L
上传目录到IPFS 需要在使用 add 命令时加上 -r ,如下:
\% v# g! [: ]
> ipfs add -r upchain+ k; Z5 G) C- {5 f
added QmQgMZKqHzyEdyJja5ioF8WaXrbUDVjqhJDoaUKDymgioi upchain/upchain.pro.txt$ b- w- v( [9 v1 _8 |! q
7 o5 }# @. n0 x! ]7 y6 S
added QmQYpGRFBpHVzoShpwU5C3XgGAxJKqY83X8VXfMbyktdbP upchain
43 B / 43 B [===========================================================================] 100.00%
+ V1 w) |' q, Z
在上传时文件夹,文件夹也会生成一个对应的hash,可以通过hash后接文件名来进行访问, 如:
5 v: l" Q- {' }3 h7 c( x% s
>ipfs cat QmQYpGRFBpHVzoShpwU5C3XgGAxJKqY83X8VXfMbyktdbP/upchain.pro.txt
) r; w0 f! z8 s+ b; G, X
在浏览器可以链接:http://127.0.0.1:8080/ipfs/QmQYp ... dbP/upchain.pro.txt 来访问。
通过上传目录的方式,可以把整个静态网站的根目录上传到IPFS网络,这样就可以省去托管服务器,例如可以直接通过以下链接访问深入浅出区块链博客:
+ a; H7 b! V |3 g6 O! E
https://ipfs.io/ipfs/QmaFWgfpRNz ... uCphq2ua/index.html
9 ]0 \* K: U9 ?+ `( S/ u7 T% X
使用IPNS解决文件更新问题
因为IPFS在IPFS中,对一个文件的内容修改后(如升级),会生成一个完全不同的新Hash,使用IPNS就可以利用同一个链接总是指向更新的内容,其实使用也很简单,只需要每次在内容更新之后使用ipfs name publish hash 发布到节点。0 s% f+ m. E, v# o- v) @
8 U3 {4 \ U" a+ h3 l9 ~, n
例如把upchain.pro.txt发布到节点,使用下面的命令:& l6 a! K6 G8 t$ y) \) \/ N$ p [
> ipfs name publish QmQgMZKqHzyEdyJja5ioF8WaXrbUDVjqhJDoaUKDymgioi$ C7 j3 a$ ^& R! x8 K
Published to QmYM36s4ut2TiufVvVUABSVWmx8VvmDU7xKUiVeswBuTva: /ipfs/QmQgMZKqHzyEdyJja5ioF8WaXrbUDVjqhJDoaUKDymgioi" a0 V- q4 r" N! I
命令中的QmQgMZKqHzyEdyJja5ioF8WaXrbUDVjqhJDoaUKDymgioi是upchain.pro.txt的hash, 命令提示中的QmYM36s4ut2TiufVvVUABSVWmx8VvmDU7xKUiVeswBuTva是当前节点id(大家可以回看一个前面ipfs init 的输出)。
发布之后就可以使用http://127.0.0.1:8080/ipns/QmYM3 ... VvmDU7xKUiVeswBuTva 或 https://ipfs.io/ipns/QmYM36s4ut2 ... VvmDU7xKUiVeswBuTva 来访问upchain.pro.txt的内容,如图:; j! z9 \1 i: N1 Q, Z
1 N1 A7 w, S9 {
其实理想下是使用 ipns://QmYM36s4ut2TiufVvVUABSVWmx8VvmDU7xKUiVeswBuTva 来访问,通过网站还是前面提到的浏览器暂不支持ipfs协议。
现在我们来更新一下upchain.pro.txt 加入文字:“创办人:Tiny熊”+ M: d5 c0 G5 l* `
% X$ ]1 h. e4 G# B/ J' A" }" ]
> echo "创办人:Tiny熊" >> upchain.pro.txt' [4 u4 I5 K. v! {! X! A* K
> ipfs add upchain.pro.txt
2 c8 ?& J) f% o5 F% r
added QmUUiDN6tWtj89xmUw1iCK2NczBqE6m3zH9QnbhHoMvZ5S upchain.pro.txt
63 B / 63 B [=============================================================] 100.00%
重新发布一下:
3 V1 d! j. @$ l
> ipfs name publish QmUUiDN6tWtj89xmUw1iCK2NczBqE6m3zH9QnbhHoMvZ5S
Published to QmYM36s4ut2TiufVvVUABSVWmx8VvmDU7xKUiVeswBuTva: /ipfs/QmUUiDN6tWtj89xmUw1iCK2NczBqE6m3zH9QnbhHoMvZ5S% i* T7 P7 d# j! b1 F" o1 A
再次访问 http://127.0.0.1:8080/ipns/QmYM3 ... VvmDU7xKUiVeswBuTva (这个链接和上面的链接一样)可以看到内容更新了。
如果我们要查询 节点id 指向的hash 可以使用 ipfs name resolve 进行查询:
- G# e4 E7 n% U0 }, o& a9 m
> ipfs name resolve% H$ H' A& ], Y/ N5 ?; Q L2 m
/ipfs/QmUUiDN6tWtj89xmUw1iCK2NczBqE6m3zH9QnbhHoMvZ5
有一点值得大家注意: 节点id其实是公钥的hash,它的关联信息是需要经过私钥签名才可以发布,因此只有我们自己才可以更新节点的指向。- Y: A. `6 Q- u' \: F$ d2 E
4 C/ t, _7 ?. d& I% m* M1 X
如果我们有多个站点需要更新,可以新产生一个秘钥对,使用新的key 发布,如:9 Z" v1 F/ r L, | ?2 R2 ], D
> ipfs key gen --type=rsa --size=2048 mykey
QmVZvdYEsdfHSR43Qm1fY8eDFrhB3UNZ2oVyEuVUH3VHrg
0 C* q0 P; Y4 ]4 u& s: T
> ipfs name publish --key=mykey hashxxx' z. M. h4 a5 g& w7 h) H3 b
Pinning6 O+ ?/ U3 _4 E0 R
9 P' e7 y; B! R3 X& w
Pinning 在IPFS里是一个很重要的概念,当我们每次请求一个网络上的内容的时候,IPFS总是会把内容先同步的本地提供服务,而为了防止 IPFS 存储空间不停增长,实际上使用cache 机制来处理文件, 如果文件在一段时间内没有被使用,文件会被”回收“。 Pinning 的作用就是把文件”钉“住,确保文件在本地不被”回收“。 如果是重要的文件,就可以使用 Pinning 防止文件被删除。
, X3 e0 d* |. j% M |
当我们使用ipfs add 添加文件时,默认会进行Pinning(使用其他命令获取的文件不会进行pinning),
5 J/ {7 l. @! B8 q! _/ O
IPFS 提供了pin命令进行Pinning操作, 比如我们查询下某一个hash 是否被pin:* R: u, p0 N& \0 I
% a" m; A% t4 K
> ipfs pin ls QmUUiDN6tWtj89xmUw1iCK2NczBqE6m3zH9QnbhHoMvZ5S6 ^$ W/ j/ i1 K0 t( s- G; D
1 ]1 j* N9 {. g* E- F1 K+ V1 j5 U
QmUUiDN6tWtj89xmUw1iCK2NczBqE6m3zH9QnbhHoMvZ5S recursive
> ipfs pin ls QmWnrAEKyDVUQ1jh9vDtQhtBSNEgUnQhAJyMmo3JjwJZK7! @) g- p0 ^5 y" L) a2 z
Error: path 'QmWnrAEKyDVUQ1jh9vDtQhtBSNEgUnQhAJyMmo3JjwJZK7' is not pinned
可以使用 pin add 手动钉住一个文件,如:- J6 }* u. }6 j1 I; }
> ipfs pin add QmWnrAEKyDVUQ1jh9vDtQhtBSNEgUnQhAJyMmo3JjwJZK7; J+ Y! ^! A6 y2 o6 X- T5 x& x, Y
3 s% y/ [! Z% o- u
pinned QmWnrAEKyDVUQ1jh9vDtQhtBSNEgUnQhAJyMmo3JjwJZK7 recursively
8 ~% B% X9 \8 g- B& T6 {( q
如果要删除pin的状态,使用pin rm , 如:* H5 l7 I H6 f& O7 }3 Z
6 F/ M: U7 b1 B% E9 T6 {" }; i
> ipfs pin rm -r QmWnrAEKyDVUQ1jh9vDtQhtBSNEgUnQhAJyMmo3JjwJZK70 w% n x3 A6 c+ e: s$ W
unpinned QmWnrAEKyDVUQ1jh9vDtQhtBSNEgUnQhAJyMmo3JjwJZK7
pin rm 的参数 -r 表示递归的删除pin 状态,对于没有pin住的文件, 如果执行GC操作 ipfs repo gc 文件会被删除。
成为第一个吐槽的人