文件列表:

CHANGELOG.md (512671, 2021-01-26)
CONTRIBUTING.md (567, 2021-01-26)
Dockerfile (4006, 2021-01-26)
GNUmakefile (109, 2021-01-26)
LICENSE (508, 2021-01-26)
LICENSE-APACHE (520, 2021-01-26)
LICENSE-MIT (1046, 2021-01-26)
Makefile (50, 2021-01-26)
Rules.mk (3776, 2021-01-26)
appveyor.yml (1444, 2021-01-26)
assets/ (0, 2021-01-26)
assets/assets.go (2202, 2021-01-26)
assets/assets_test.go (1064, 2021-01-26)
assets/bindata.go (214044, 2021-01-26)
assets/bindata_dep.go (180, 2021-01-26)
assets/bindata_version_hash.go (191, 2021-01-26)
assets/init-doc/ (0, 2021-01-26)
assets/init-doc/about (1681, 2021-01-26)
assets/init-doc/contact (189, 2021-01-26)
assets/init-doc/docs/ (0, 2021-01-26)
assets/init-doc/docs/index (6, 2021-01-26)
assets/init-doc/help (311, 2021-01-26)
assets/init-doc/ping (4, 2021-01-26)
assets/init-doc/quick-start (1681, 2021-01-26)
assets/init-doc/security-notes (1162, 2021-01-26)
bin/ (0, 2021-01-26)
bin/Rules.mk (433, 2021-01-26)
bin/archive-branches.sh (1601, 2021-01-26)
bin/check_go_version (1134, 2021-01-26)
bin/check_version (2533, 2021-01-26)
bin/collect-profiles.sh (1655, 2021-01-26)
bin/container_daemon (1477, 2021-01-26)
bin/dist_get (3998, 2021-01-26)
bin/gencmdref (788, 2021-01-26)
bin/graphmd (723, 2021-01-26)
bin/ipns-republish (684, 2021-01-26)
bin/maketarball.sh (541, 2021-01-26)
... ...

# go-ipfs  [](http://ipn.io) [](https://matrix.to/#/room/#ipfs:matrix.org) [](http://webchat.freenode.net/?channels=%23ipfs) [](https://discord.gg/24fmuwR) [](https://godoc.org/github.com/ipfs/go-ipfs) [](https://github.com/RichardLitt/standard-readme) [](https://circleci.com/gh/ipfs/go-ipfs) ## What is IPFS? IPFS is a global, versioned, peer-to-peer filesystem. It combines good ideas from previous systems such as Git, BitTorrent, Kademlia, SFS, and the Web. It is like a single BitTorrent swarm, exchanging git objects. IPFS provides an interface as simple as the HTTP web, but with permanence built-in. You can also mount the world at /ipfs. For more info see: https://docs.ipfs.io/introduction/overview/ Before opening an issue, consider using one of the following locations to ensure you are opening your thread in the right place: - go-ipfs _implementation_ bugs in [this repo](https://github.com/ipfs/go-ipfs/issues). - Documentation issues in [ipfs/docs issues](https://github.com/ipfs/docs/issues). - IPFS _design_ in [ipfs/specs issues](https://github.com/ipfs/specs/issues). - Exploration of new ideas in [ipfs/notes issues](https://github.com/ipfs/notes/issues). - Ask questions and meet the rest of the community at the [IPFS Forum](https://discuss.ipfs.io). ## Table of Contents - [Security Issues](#security-issues) - [Install](#install) - [System Requirements](#system-requirements) - [Install prebuilt packages](#install-prebuilt-packages) - [From Linux package managers](#from-linux-package-managers) - [Build from Source](#build-from-source) - [Install Go](#install-go) - [Download and Compile IPFS](#download-and-compile-ipfs) - [Troubleshooting](#troubleshooting) - [Updating go-ipfs](#updating-go-ipfs) - [Getting Started](#getting-started) - [Some things to try](#some-things-to-try) - [Usage](#usage) - [Running IPFS inside Docker](#running-ipfs-inside-docker) - [Troubleshooting](#troubleshooting-1) - [Packages](#packages) - [Development](#development) - [CLI, HTTP-API, Architecture Diagram](#cli-http-api-architecture-diagram) - [Testing](#testing) - [Development Dependencies](#development-dependencies) - [Contributing](#contributing) - [License](#license) ## Security Issues The IPFS protocol and its implementations are still in heavy development. This means that there may be problems in our protocols, or there may be mistakes in our implementations. And -- though IPFS is not production-ready yet -- many people are already running nodes in their machines. So we take security vulnerabilities very seriously. If you discover a security issue, please bring it to our attention right away! If you find a vulnerability that may affect live deployments -- for example, by exposing a remote execution exploit -- please send your report privately to security@ipfs.io. Please DO NOT file a public issue. If the issue is a protocol weakness that cannot be immediately exploited or something not yet deployed, just discuss it openly. ## Install The canonical download instructions for IPFS are over at: https://docs.ipfs.io/guides/guides/install/. It is **highly recommended** you follow those instructions if you are not interested in working on IPFS development. ### System Requirements IPFS can run on most Linux, macOS, and Windows systems. We recommend running it on a machine with at least 2 GB of RAM and 2 CPU cores (go-ipfs is highly parallel). On systems with less memory, it may not be completely stable. If your system is resource-constrained, we recommend: 1. Installing OpenSSL and rebuilding go-ipfs manually with `make build GOTAGS=openssl`. See the [download and compile](#download-and-compile-ipfs) section for more information on compiling go-ipfs. 2. Initializing your daemon with `ipfs init --profile=lowpower` ### Install prebuilt packages We host prebuilt binaries over at our [distributions page](https://ipfs.io/ipns/dist.ipfs.io#go-ipfs). From there: - Click the blue "Download go-ipfs" on the right side of the page. - Open/extract the archive. - Move `ipfs` to your path (`install.sh` can do it for you). You can also download go-ipfs from this project's GitHub releases page if you are unable to access ipfs.io. ### From Linux package managers - [Arch Linux](#arch-linux) - [Nix](#nix) - [Solus](#solus) - [Snap](#snap) #### Arch Linux In Arch Linux go-ipfs is available as [go-ipfs](https://www.archlinux.org/packages/community/x86_64/go-ipfs/) package. ``` $ sudo pacman -S go-ipfs ``` Development version of go-ipfs is also on AUR under [go-ipfs-git](https://aur.archlinux.org/packages/go-ipfs-git/). You can install it using your favorite AUR Helper or manually from AUR. #### Nix For Linux and MacOSX you can use the purely functional package manager [Nix](https://nixos.org/nix/): ``` $ nix-env -i ipfs ``` You can also install the Package by using its attribute name, which is also `ipfs`. #### Guix GNU's functional package manager, [Guix](https://www.gnu.org/software/guix/), also provides a go-ipfs package: ``` $ guix package -i go-ipfs ``` #### Solus In solus, go-ipfs is available in the main repository as [go-ipfs](https://dev.getsol.us/source/go-ipfs/repository/master/). ``` $ sudo eopkg install go-ipfs ``` You can also install it through the Solus software center. #### Snap With snap, in any of the [supported Linux distributions](https://snapcraft.io/docs/core/install): ``` $ sudo snap install ipfs ``` ### From Windows package managers - [Chocolatey](#chocolatey) - [Scoop](#scoop) #### Chocolatey The package [ipfs](https://chocolatey.org/packages/ipfs) currently points to go-ipfs and is being maintained. ```Powershell PS> choco install ipfs ``` #### Scoop Scoop provides `go-ipfs` in its 'extras' bucket. ```Powershell PS> scoop bucket add extras PS> scoop install go-ipfs ``` ### Build from Source go-ipfs's build system requires Go 1.14.4 and some standard POSIX build tools: * GNU make * Git * GCC (or some other go compatible C Compiler) (optional) To build without GCC, build with `CGO_ENABLED=0` (e.g., `make build CGO_ENABLED=0`). #### Install Go The build process for ipfs requires Go 1.14.4 or higher. If you don't have it: [Download Go 1.14+](https://golang.org/dl/). You'll need to add Go's bin directories to your `$PATH` environment variable e.g., by adding these lines to your `/etc/profile` (for a system-wide installation) or `$HOME/.profile`: ``` export PATH=$PATH:/usr/local/go/bin export PATH=$PATH:$GOPATH/bin ``` (If you run into trouble, see the [Go install instructions](https://golang.org/doc/install)). #### Download and Compile IPFS ``` $ git clone https://github.com/ipfs/go-ipfs.git $ cd go-ipfs $ make install ``` Alternatively, you can run `make build` to build the go-ipfs binary (storing it in `cmd/ipfs/ipfs`) without installing it. **NOTE:** If you get an error along the lines of "fatal error: stdlib.h: No such file or directory", you're missing a C compiler. Either re-run `make` with `CGO_ENABLED=0` or install GCC. ##### Cross Compiling Compiling for a different platform is as simple as running: ``` make build GOOS=myTargetOS GOARCH=myTargetArchitecture ``` ##### OpenSSL To build go-ipfs with OpenSSL support, append `GOTAGS=openssl` to your `make` invocation. Building with OpenSSL should significantly reduce the background CPU usage on nodes that frequently make or receive new connections. Note: OpenSSL requires CGO support and, by default, CGO is disabled when cross-compiling. To cross-compile with OpenSSL support, you must: 1. Install a compiler toolchain for the target platform. 2. Set the `CGO_ENABLED=1` environment variable. #### Troubleshooting - Separate [instructions are available for building on Windows](docs/windows.md). - `git` is required in order for `go get` to fetch all dependencies. - Package managers often contain out-of-date `golang` packages. Ensure that `go version` reports at least 1.10. See above for how to install go. - If you are interested in development, please install the development dependencies as well. - _WARNING_: Older versions of OSX FUSE (for Mac OS X) can cause kernel panics when mounting!- We strongly recommend you use the [latest version of OSX FUSE](http://osxfuse.github.io/). (See https://github.com/ipfs/go-ipfs/issues/177) - For more details on setting up FUSE (so that you can mount the filesystem), see the docs folder. - Shell command completion is available in `misc/completion/ipfs-completion.bash`. Read [docs/command-completion.md](docs/command-completion.md) to learn how to install it. - See the [misc folder](https://github.com/ipfs/go-ipfs/tree/master/misc) for how to connect IPFS to systemd or whatever init system your distro uses. ### Updating go-ipfs #### Using ipfs-update IPFS has an updating tool that can be accessed through `ipfs update`. The tool is not installed alongside IPFS in order to keep that logic independent of the main codebase. To install `ipfs update`, [download it here](https://ipfs.io/ipns/dist.ipfs.io/#ipfs-update). #### Downloading IPFS builds using IPFS List the available versions of go-ipfs: ``` $ ipfs cat /ipns/dist.ipfs.io/go-ipfs/versions ``` Then, to view available builds for a version from the previous command ($VERSION): ``` $ ipfs ls /ipns/dist.ipfs.io/go-ipfs/$VERSION ``` To download a given build of a version: ``` $ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_darwin-386.tar.gz # darwin 32-bit build $ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_darwin-amd64.tar.gz # darwin 64-bit build $ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_freebsd-amd64.tar.gz # freebsd 64-bit build $ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-386.tar.gz # linux 32-bit build $ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-amd64.tar.gz # linux 64-bit build $ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-arm.tar.gz # linux arm build $ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_windows-amd64.zip # windows 64-bit build ``` ## Getting Started See also: https://docs.ipfs.io/introduction/usage/ To start using IPFS, you must first initialize IPFS's config files on your system, this is done with `ipfs init`. See `ipfs init --help` for information on the optional arguments it takes. After initialization is complete, you can use `ipfs mount`, `ipfs add` and any of the other commands to explore! ### Some things to try Basic proof of 'ipfs working' locally: echo "hello world" > hello ipfs add hello # This should output a hash string that looks something like: # QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o ipfs cat ### Usage ``` ipfs - Global p2p merkle-dag filesystem. ipfs [] [] ... SUBCOMMANDS BASIC COMMANDS init Initialize ipfs local configuration add Add a file to ipfs cat Show ipfs object data get Download ipfs objects ls List links from an object refs List hashes of links from an object DATA STRUCTURE COMMANDS block Interact with raw blocks in the datastore object Interact with raw dag nodes files Interact with objects as if they were a unix filesystem 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 or resolve IPNS names dns Resolve DNS links pin Pin objects to local storage repo Manipulate an IPFS repository 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 TOOL COMMANDS config Manage configuration version Show ipfs version information update Download and apply go-ipfs updates commands List all available commands Use 'ipfs --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 ``` ### Running IPFS inside Docker An IPFS docker image is hosted at [hub.docker.com/r/ipfs/go-ipfs](https://hub.docker.com/r/ipfs/go-ipfs/). To make files visible inside the container you need to mount a host directory with the `-v` option to docker. Choose a directory that you want to use to import/export files from IPFS. You should also choose a directory to store IPFS files that will persist when you restart the container. export ipfs_staging= export ipfs_data= Start a container running ipfs and expose ports 4001, 5001 and 8080: docker run -d --name ipfs_host -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/go-ipfs:latest Watch the ipfs log: docker logs -f ipfs_host Wait for ipfs to start. ipfs is running when you see: Gateway (readonly) server listening on /ip4/0.0.0.0/tcp/8080 You can now stop watching the log. Run ipfs commands: docker exec ipfs_host ipfs For example: connect to peers docker exec ipfs_host ipfs swarm peers Add files: cp -r $ipfs_staging docker exec ipfs_host ipfs add -r /export/ Stop the running container: docker stop ipfs_host When starting a container running ipfs for the first time with an empty data directory, it will call `ipfs init` to initialize configuration files and generate a new keypair. At this time, you can choose which profile to apply using the `IPFS_PROFILE` environment variable: docker run -d --name ipfs_host -e IPFS_PROFILE=server -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/go-ipfs:latest #### Private swarms inside Docker It is possible to initialize the container with a swarm key file (`/data/ipfs/swarm.key`) using the variables `IPFS_SWARM_KEY` and `IPFS_SWARM_KEY_FILE`. The `IPFS_SWARM_KEY` creates `swarm.key` with the contents of the variable itself, whilst `IPFS_SWARM_KEY_FILE` copies the key from a path stored in the variable. The `IPFS_SWARM_KEY_FILE` **overwrites** the key generated by `IPFS_SWARM_KEY`. docker run -d --name ipfs_host -e IPFS_SWARM_KEY= -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/go-ipfs:latest The swarm key initialization can also be done using docker secrets **(requires docker swarm or docker-compose)**: cat your_swarm.key | docker secret create swarm_key_secret - docker run -d --name ipfs_host --secret swarm_key_secret -e IPFS_SWARM_KEY_FILE=/run/secrets/swarm_key_secret -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/go-ipfs:latest #### Key rotation inside Docker If needed, it is possible to do key rotation in an ephemeral container that is temporarily executing against a volume that is mounted under `/data/ipfs`: ```sh # given container named 'ipfs-test' that persists repo at /path/to/persisted/.ipfs $ docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/go-ipfs:v0.7.0 $ docker stop ipfs-test # key rotation works like this (old key saved under 'old-self') $ docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/go-ipfs:v0.7.0 key rotate -o old-self -t ed25519 $ docker start ipfs-test # will start with the new key ``` ### Troubleshooting If you have previously installed IPFS before and you are running into problems getting a newer version to work, try deleting (or backing up somewhere else) your IPFS config directory (~/.ipfs by default) and rerunning `ipfs init`. This will reinitialize the config file to its defaults and clear out the local datastore of any bad entries. Please direct general questions and help requests to our [forum](https://discuss.ipfs.io) or our IRC channel (freenode #ipfs). If you believe you've found a bug, check the [issues list](https://github.com/ipfs/go-ipfs/issues) and, if you don't see your problem there, either come talk to us on IRC (freenode #ipfs) or file an issue of your own! ## Packages > This table is generated using the module [`package-table`](https://github.com/ipfs-shipyard/package-table) with `package-table --data=package-list.json`. Listing of the main packages used in the IPFS ecosystem. There are also three specifications worth linking here: | Name | CI/Travis | Coverage | Description | | ---------|---------|---------|--------- | | **Libp2p** | | [`go-libp2p`](//github.com/libp2p/go-libp2p) | [](https://travis-ci.com/libp2p/go-libp2p) | [](https://codecov.io/gh/libp2p/go-libp2p) | p2p networking library | | [`go-libp2p-pubsub`](//github.com/libp2p/go-libp2p-pubsub) | [](https://travis-ci.com/libp2p/go-libp2p-pubsub) | [](https://codecov.io/gh/libp2p/go-libp2p-pubsub) | pubsub built on libp2p | | [`go-libp2p-kad-dht`](//github.com/libp2p/go-libp2p-kad-dht) | [](https://travis-ci.com/libp2p/go-libp2p-kad-dht) | [](https://codecov.io/gh/libp2p/go-libp2p-kad-dht) | dht-backed router | | [`go-libp2p-pubsub-router`](//github.com/libp2p/go-libp2p-pubsub-router) | [](https://travis-ci.com/libp2p/go-libp2p-pubsub-router) | [](https://codecov.io/gh/libp2p/go-libp2p-pubsub-router) | pubsub-backed router | | **Multiformats** | | [`go-cid`](//github.com/ipfs/go-cid) | [](https://travis-ci.com/ipfs/go-cid) | [![codecov](https://codecov.io/gh/ipfs/go-cid/branch/master/grap ... ...

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：