IPFS 搭建

Posted loversmile

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了IPFS 搭建相关的知识,希望对你有一定的参考价值。

IPFS 搭建

官网

https://ipfs.io 可能需要梯子

下载和编译

下载代码

git clone https://github.com/ipfs/go-ipfs.git
首先需要 1.16版本以上的go环境
下载go

安装go

ubuntu@ubuntu-sol:~/IPFS$wget https://golang.org/dl/go1.17.2.linux-amd64.tar.gz
ubuntu@ubuntu-sol:~/IPFS$tar -zxvf go1.17.2.linux-amd64.tar.gz
ubuntu@ubuntu-sol:~/IPFS$sudo mv go /usr/local
ubuntu@ubuntu-sol:~/IPFS$vi ~/.profile
在末尾输入 export PATH=$PATH:/usr/local/go/bin
ubuntu@ubuntu-sol:~/IPFS$source ~/.profile
ubuntu@ubuntu-sol:~/IPFS$ go version
go version go1.17.2 linux/amd64

源码

找一个目录,下载源码

ubuntu@ubuntu-sol:~/IPFS$ mkdir ipfs && cd ipfs
ubuntu@ubuntu-sol:~/IPFS/ipfs$ git clone https://github.com/ipfs/go-ipfs.git
ubuntu@ubuntu-sol:~/IPFS/ipfs$ cd go-ipfs
## 选择需要的版本
ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ git checkout v0.10.0

编译IPFS

编译安装比较久,可以使用下面的官方直接下载release好的ipfs进行安装

ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ make build
ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ make install

官方release的ipfs

可以通过下面的链接直接下载官方编译好的ipfs
https://github.com/ipfs/go-ipfs/releases
文档采用的是下面这个地址
https://github.com/ipfs/go-ipfs/releases/download/v0.10.0/go-ipfs_v0.10.0_linux-amd64.tar.gz
压缩包里面的和源码 go-ipfs/cmd/ipfs/dist目录下内容是一样的,只是没有ipfs 文件,源码编译后,会在ipfs目录下生成ipfs文件

ubuntu@ubuntu-sol:~/IPFS/ipfs$ tar -zxf go-ipfs_v0.10.0_linux-amd64.tar.gz
ubuntu@ubuntu-sol:~/IPFS/ipfs$ cd go-ipfs
ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ ls
install.sh  ipfs  LICENSE  LICENSE-APACHE  LICENSE-MIT  README.md
ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ sudo ./install.sh 
Moved ./ipfs to /usr/local/bin

测试

输入ipfs help 测试安装成功

ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ ipfs --version
ipfs version 0.10.0
ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ ipfs help
USAGE
  ipfs  - Global p2p merkle-dag filesystem.

SYNOPSIS
  ipfs [--config=<config> | -c] [--debug | -D] [--help] [-h] [--api=<api>] [--offline] [--cid-base=<base>] [--upgrade-cidv0-in-output] [--encoding=<encoding> | --enc] [--timeout=<timeout>] <command> ...

OPTIONS

  -c, --config               string - Path to the configuration file to use.
  -D, --debug                bool   - Operate in debug mode.
  --help                     bool   - Show the full command help text.
  -h                         bool   - Show a short version of the command help text.
  -L, --local                bool   - Run the command locally, instead of using the daemon. DEPRECATED: use --offline.
  --offline                  bool   - Run the command offline.
  --api                      string - Use a specific API instance (defaults to /ip4/127.0.0.1/tcp/5001).
  --cid-base                 string - Multibase encoding used for version 1 CIDs in output.
  --upgrade-cidv0-in-output  bool   - Upgrade version 0 to version 1 CIDs in output.
  --enc, --encoding          string - The encoding type the output should be encoded with (json, xml, or text). Default: text.
  --stream-channels          bool   - Stream channel output.
  --timeout                  string - Set a global timeout on the command.

SUBCOMMANDS
  BASIC COMMANDS
    init          Initialize local IPFS configuration
    add <path>    Add a file to IPFS
    cat <ref>     Show IPFS object data
    get <ref>     Download IPFS objects
    ls <ref>      List links from an object
    refs <ref>    List hashes of links from an object
  
  DATA STRUCTURE COMMANDS
    dag           Interact with IPLD DAG nodes
    files         Interact with files as if they were a unix filesystem
    block         Interact with raw blocks in the datastore
  
  TEXT ENCODING COMMANDS
    cid           Convert and discover properties of CIDs
    multibase     Encode and decode data with Multibase format
  
  ADVANCED COMMANDS
    daemon        Start a long-running daemon process
    mount         Mount an IPFS read-only mount point
    resolve       Resolve any type of name
    name          Publish and resolve IPNS names
    key           Create and list IPNS name keypairs
    dns           Resolve DNS links
    pin           Pin objects to local storage
    repo          Manipulate the IPFS repository
    stats         Various operational stats
    p2p           Libp2p stream mounting
    filestore     Manage the filestore (experimental)
  
  NETWORK COMMANDS
    id            Show info about IPFS peers
    bootstrap     Add or remove bootstrap peers
    swarm         Manage connections to the p2p network
    dht           Query the DHT for values or peers
    ping          Measure the latency of a connection
    diag          Print diagnostics
    bitswap       Inspect bitswap state
    pubsub        Send and receive messages via pubsub
  
  TOOL COMMANDS
    config        Manage configuration
    version       Show IPFS version information
    update        Download and apply go-ipfs updates
    commands      List all available commands
    log           Manage and show logs of running daemon
  
  Use 'ipfs <command> --help' to learn more about each command.
  
  ipfs uses a repository in the local file system. By default, the repo is
  located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
  environment variable:
  
    export IPFS_PATH=/path/to/ipfsrepo
  
  EXIT STATUS
  
  The CLI will exit with one of the following values:
  
  0     Successful execution.
  1     Failed executions.

  For more information about each command, use:
  'ipfs <subcmd> --help'

初始化ipfs

ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ ipfs init
generating ED25519 keypair...done
peer identity: 12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6
initializing IPFS node at /home/ubuntu/.ipfs
to get started, enter:

        ipfs cat /ipfs/QmQPeNsJPyVWPFDVHb77w8G42Fvo15z4bG2X8D2GhfbSXc/readme
        
ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ ipfs cat /ipfs/QmQPeNsJPyVWPFDVHb77w8G42Fvo15z4bG2X8D2GhfbSXc/readme
Hello and Welcome to IPFS!

██╗██████╗ ███████╗███████╗
██║██╔══██╗██╔════╝██╔════╝
██║██████╔╝█████╗  ███████╗
██║██╔═══╝ ██╔══╝  ╚════██║
██║██║     ██║     ███████║
╚═╝╚═╝     ╚═╝     ╚══════╝

If you're seeing this, you have successfully installed
IPFS and are now interfacing with the ipfs merkledag!

 -------------------------------------------------------
| Warning:                                              |
|   This is alpha software. Use at your own discretion! |
|   Much is missing or lacking polish. There are bugs.  |
|   Not yet secure. Read the security notes for more.   |
 -------------------------------------------------------

Check out some of the other files in this directory:

  ./about
  ./help
  ./quick-start     <-- usage examples
  ./readme          <-- this file
  ./security-notes

查看id

节点搭建成功之后我们可以通过 ipfs id 命令查看自己的本机id

ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ ipfs id
{
        "ID": "12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
        "PublicKey": "CAESIMzaxMDeC5b4HZgWuNxfh94PWg9al4C22hhBt2wks+6F",
        "Addresses": null,
        "AgentVersion": "go-ipfs/0.10.0/",
        "ProtocolVersion": "ipfs/0.1.0",
        "Protocols": null
}

配置启动

配置其他机器访问

ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["*"]'
ipfs config --json Addresses.API '"/ip4/0.0.0.0/tcp/5001"'

启动

ubuntu@ubuntu-sol:~/IPFS/ipfs/go-ipfs$ ipfs daemon
Initializing daemon...
go-ipfs version: 0.10.0
Repo version: 11
System version: amd64/linux
Golang version: go1.16.8
2021/10/26 15:17:14 failed to sufficiently increase receive buffer size (was: 208 kiB, wanted: 2048 kiB, got: 416 kiB). See https://github.com/lucas-clemente/quic-go/wiki/UDP-Receive-Buffer-Size for details.
Swarm listening on /ip4/127.0.0.1/tcp/4001
Swarm listening on /ip4/127.0.0.1/udp/4001/quic
Swarm listening on /ip4/192.168.0.17/tcp/4001
Swarm listening on /ip4/192.168.0.17/udp/4001/quic
Swarm listening on /ip6/::1/tcp/4001
Swarm listening on /ip6/::1/udp/4001/quic
Swarm listening on /p2p-circuit
Swarm announcing /ip4/127.0.0.1/tcp/4001
Swarm announcing /ip4/127.0.0.1/udp/4001/quic
Swarm announcing /ip4/192.168.0.17/tcp/4001
Swarm announcing /ip4/192.168.0.17/udp/4001/quic
Swarm announcing /ip6/::1/tcp/4001
Swarm announcing /ip6/::1/udp/4001/quic
API server listening on /ip4/0.0.0.0/tcp/5001
WebUI: http://0.0.0.0:5001/webui
Gateway (readonly) server listening on /ip4/127.0.0.1/tcp/8080
Daemon is ready

启动后查看id

ubuntu@ubuntu-sol:~/.ipfs$ ipfs id
{
        "ID": "12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
        "PublicKey": "CAESIMzaxMDeC5b4HZgWuNxfh94PWg9al4C22hhBt2wks+6F",
        "Addresses": [
                "/ip4/127.0.0.1/tcp/4001/p2p/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
                "/ip4/127.0.0.1/udp/4001/quic/p2p/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
                "/ip4/192.168.0.17/tcp/4001/p2p/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
                "/ip4/192.168.0.17/udp/4001/quic/p2p/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
                "/ip4/220.189.210.50/tcp/2417/p2p/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
                "/ip4/220.189.210.50/tcp/2418/p2p/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
                "/ip4/220.189.210.50/udp/2431/quic/p2p/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
                "/ip4/220.189.210.50/udp/2457/quic/p2p/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
                "/ip6/::1/tcp/4001/p2p/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6",
                "/ip6/::1/udp/4001/quic/p2p/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6"
        ],
        "AgentVersion": "go-ipfs/0.10.0/",
        "ProtocolVersion": "ipfs/0.1.0",
        "Protocols": [
                "/ipfs/bitswap",
                "/ipfs/bitswap/1.0.0",
                "/ipfs/bitswap/1.1.0",
                "/ipfs/bitswap/1.2.0",
                "/ipfs/id/1.0.0",
                "/ipfs/id/push/1.0.0",
                "/ipfs/lan/kad/1.0.0",
                "/ipfs/ping/1.0.0",
                "/libp2p/autonat/1.0.0",
                "/libp2p/circuit/relay/0.1.0",
                "/p2p/id/delta/1.0.0",
                "/x/"
        ]
}

网页查看

http://192.186.0.17:5001/webui
会跳转到
http://192.168.0.17:5001/ipfs/bafybeihcyruaeza7uyjd6ugicbcrqumejf6uf353e5etdkhotqffwtguva/#/

示例

直接使用ipfs 上传文件
ubuntu@ubuntu-sol:~/test$ ipfs add test3
added QmTZpQW6Vq65LTHUuJUbrNHmFdgGwP1spTvLRZkQwGmdj9 test3
 15 B / 15 B [======================] 100.00%
使用ipfs 上传目录
ubuntu@ubuntu-sol:~/test$ ipfs add -r testdir
added QmSwLYeFSWzifHNypYrkfx39zPXTpGNDLD5WdmLS8hWLot testdir/test2
added QmTZpQW6Vq65LTHUuJUbrNHmFdgGwP1spTvLRZkQwGmdj9 testdir/test3
added QmTqoHrSQuJXdJ4cFgVpv59P1yVjpjcajDqUeWDVSaiaxb testdir
 21 B / 21 B [======================] 100.00%
使用HTTP API 上传文件

curl example

curl -X POST -F file=@myfile "http://127.0.0.1:5001/api/v0/add?quiet=<value>&quieter=<value>&silent=<value>&progress=<value>&trickle=<value>&only-hash=<value>&wrap-with-directory=<value>&chunker=size-262144&pin=true&raw-leaves=<value>&nocopy=<value>&fscache=<value>&cid-version=<value>&hash=sha2-256&inline=<value>&inline-limit=32"

上面<value> 是参数的值,需要修改,除了cid-version 是int类型,其他都是bool类型(可以用true/false 或者0/1),参数根据需要使用

参数说明可以参考 IPFS HTTP API http-commands

注意file=@myfile这个@,没有这个@上传的就成了文件名,而不是文件的内容了

下面是上传一个文件名为 tstst 的测试文件的例子

默认情况下可以不加参数

ubuntu@ubuntu-sol:~/test/heihei$ curl -X POST -F file=@tstst "http://127.0.0.1:5001/api/v0/add"
{"Name":"tstst","Hash":"QmfUJdALjZxhsiyBLyccj9sZFpygAEhk5UUfLVCi45rZND","Size":"34"}
ubuntu@ubuntu-sol:~/test/heihei$ ipfs cat /ipfs/QmfUJdALjZxhsiyBLyccj9sZFpygAEhk5UUfLVCi45rZND
This is a ipfs test file.

如上所示,上传成功后可看到文件的Hash值,可以通过这个Hash 去webui查看上传的文件是不是正确的

也可以通过webui上传文件
查看文件的cid为QmVP7TY79k7ozPna5vPnxUANS68kpPdcLs4s7XTtdzN7Vn
通过ipfs的命令获取文件

ipfs cat /ipfs/QmVP7TY79k7ozPna5vPnxUANS68kpPdcLs4s7XTtdzN7Vn > tu.jpg

因为这里上传的是一个图片,直接获取看不到,所以重定向到一个jpg文件查看

使用IPNS

在IPFS中,对一个文件的内容修改后(如升级),会生成一个完全不同的新Hash,使用IPNS就可以利用同一个链接总是指向更新的内容,其实使用也很简单,只需要每次在内容更新之后使用ipfs name publish hash 发布到节点。

ubuntu@ubuntu-sol:~/test$ ipfs name publish QmTZpQW6Vq65LTHUuJUbrNHmFdgGwP1spTvLRZkQwGmdj9
Published to k51qzi5uqu5dlaeb0xwy5kx53q8ofyj036rhn8n529n1js070983cdgu8y3kw5: /ipfs/QmTZpQW6Vq65LTHUuJU$ ipfs name publish QmSwLYeFSWzifHNypYrkfx39zPXTpGNDLD5WdmLS8hWLot
Published to k51qzi5uqu5dlaeb0xwy5kx53q8ofyj036rhn8n529n1js070983cdgu8y3kw5: /ipfs/QmSwLYeFSWzifHNypYrkfx39zPXTpGNDLD5WdmLS8hWLot

这里 QmTZpQW6Vq65LTHUuJUbrNHmFdgGwP1spTvLRZkQwGmdj9 是test3文件的hash,QmSwLYeFSWzifHNypYrkfx39zPXTpGNDLD5WdmLS8hWLot 是test2文件的hash,两次publish后可以看到得到的是相同的地址,k51qzi5uqu5dlaeb0xwy5kx53q8ofyj036rhn8n529n1js070983cdgu8y3kw5,前后两次 访问相同的地址http://192.168.0.17:8080/ipns/k51qzi5uqu5dlaeb0xwy5kx53q8ofyj036rhn8n529n1js070983cdgu8y3kw5 得到的内容分别是test3和test2的内容

也可以通过当前节点ID来访问,就是 ipfs init 命令后生成的 peer identity,通过ipfs id可以查看当前节点ID http://192.168.0.17:8080/ipns/12D3KooWPc2pTzK4VtPnoN8x9dTdGUvUSzVkRX9U7gX6sg7Szoh6 的结果和上面http://192.168.0.17:8080/ipns/k51qzi5uqu5dlaeb0xwy5kx53q8ofyj036rhn8n529n1js070983cdgu8y3kw5的结果是一样的

查看目前链接所指向的文件

ubuntu@ubuntu-sol:~/test$ ipfs name resolve
/ipfs/QmSwLYeFSWzifHNypYrkfx39zPXTpGNDLD5WdmLS8hWLot

如果有多个文件需要使用IPNS,可以新建一key,将不同的文件 publish 到不同的key 上去,上面的k51qzi5uqu5dlaeb0xwy5kx53q8ofyj036rhn8n529n1js070983cdgu8y3kw5其实就是系统生成的默认的key,

# 生成key
ubuntu@ubuntu-sol:~/test/$ ipfs key gen --type=rsa --size=2048 mykey
k2k4r8o5eus56y2m378zzjhuwu6x5rb2p0rv0bg6slb3nt9spzreg6u8
# 使用生成的key publish QmTZpQW6Vq65LTHUuJUbrNHmFdgGwP1spTvLRZkQwGmdj9
ubuntu@ubuntu-sol:~/test$ ipfs name publish -key=mykey QmTZpQW6Vq65LTHUuJUbrNHmFdgGwP1spTvLRZkQwGmdj9
Published to k2k4r8o5eus56y2m378zzjhuwu6x5rb2p0rv0bg6slb3nt9spzreg6u8: /ipfs/QmTZpQW6Vq65LTHUuJUbrNHmFdgGwP1spTvLRZkQwGmdj9
# 使用ipfs name resolve 看到的还是默认的
ubuntu@ubuntu-sol:~/test/heihei$ ipfs name resolve
/ipfs/QmSwLYeFSWzifHNypYrkfx39zPXTpGNDLD5WdmLS8hWLot
# 使用 ipfs name resolve 加 key 可以看到该 key 对应的文件
ubuntu@ubuntu-sol:~/test/heihei$ ipfs name resolve k2k4r8o5eus56y2m378zzjhuwu6x5rb2p0rv0bg6slb3nt9spzreg6u8
/ipfs/QmTZpQW6Vq65LTHUuJUbrNHmFdgGwP1spTvLRZkQwGmdj9

API

https://docs.ipfs.io/reference/http/api/

参考

https://docs.ipfs.io/

https://github.com/ipfs/go-ipfs/tree/v0.10.0#install-prebuilt-binaries

https://github.com/ipfs/go-ipfs/tree/v0.10.0#download-and-compile-ipfs

以上是关于IPFS 搭建的主要内容,如果未能解决你的问题,请参考以下文章

IPFS系列 集群搭建 三

如何在node中运行下面的IPFS示例?

使用seaweedfs搭建一个图片服务器 (上)

基于区块链/Hyperledger Fabric与IPFS的电子病历数据传输系统搭建流程

如何在恒讯云服务器上搭建个人IPFS分布式存储文件系统?

快速搭建部署SPA应用到Web3.0(IPFS)