README
¶
IPFS Network
IPFS Network
cloned from https://github.com/ipfs/go-ipfs.git
Docker
$ docker build -t ipfs_network . && docker run -p 4001:4001 -p 5001:5001 -p 8080:8080 -p 8081:8081 ipfs_network
Documentation
¶
Overview ¶
IPFS is a global, versioned, peer-to-peer filesystem
There are sub-packages within the ipfs package for various low-level utilities, which are in turn assembled into:
core/...:
The low-level API that gives consumers all the knobs they need, which we try hard to keep stable.
shell/...:
The high-level API that gives consumers easy access to common operations (e.g. create a file node from a reader without wrapping with metadata). We work really hard to keep this stable.
Then on top of the core/... and shell/... Go APIs, we have:
cmd/...:
Command-line executables
test/...:
Integration tests, etc.
To avoid cyclic imports, imports should never pull in higher-level APIs into a lower-level package. For example, you could import all of core and shell from cmd/... or test/..., but you couldn't import any of shell from core/....
Index ¶
Constants ¶
View Source
const ApiVersion = "/go-ipfs/" + CurrentVersionNumber + "/"
View Source
const CurrentVersionNumber = "0.4.19-dev"
CurrentVersionNumber is the current application's version literal
Variables ¶
View Source
var CurrentCommit string
CurrentCommit is the current git commit, this is set as a ldflag in the Makefile
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
blocks
|
|
|
blockstoreutil
Package blockstoreutil provides utility functions for Blockstores.
|
Package blockstoreutil provides utility functions for Blockstores. |
|
cmd
|
|
|
ipfs
cmd/ipfs implements the primary CLI binary for ipfs
|
cmd/ipfs implements the primary CLI binary for ipfs |
|
seccat
package main provides an implementation of netcat using the secio package.
|
package main provides an implementation of netcat using the secio package. |
|
Package core implements the IpfsNode object and related methods.
|
Package core implements the IpfsNode object and related methods. |
|
commands
Package commands implements the ipfs command interface
|
Package commands implements the ipfs command interface |
|
coreapi
Package coreapi provides direct access to the core commands in IPFS.
|
Package coreapi provides direct access to the core commands in IPFS. |
|
coreapi/interface
Package iface defines IPFS Core API which is a set of interfaces used to interact with IPFS nodes.
|
Package iface defines IPFS Core API which is a set of interfaces used to interact with IPFS nodes. |
|
corehttp
Package corehttp provides utilities for the webui, gateways, and other high-level HTTP interfaces to IPFS.
|
Package corehttp provides utilities for the webui, gateways, and other high-level HTTP interfaces to IPFS. |
|
corerepo
Package corerepo provides pinning and garbage collection for local IPFS block services.
|
Package corerepo provides pinning and garbage collection for local IPFS block services. |
|
exchange
|
|
|
Package filestore implements a Blockstore which is able to read certain blocks of data directly from its original location in the filesystem.
|
Package filestore implements a Blockstore which is able to read certain blocks of data directly from its original location in the filesystem. |
|
fuse
|
|
|
ipns
package fuse/ipns implements a fuse filesystem that interfaces with ipns, the naming system for ipfs.
|
package fuse/ipns implements a fuse filesystem that interfaces with ipns, the naming system for ipfs. |
|
mount
package mount provides a simple abstraction around a mount point
|
package mount provides a simple abstraction around a mount point |
|
readonly
package fuse/readonly implements a fuse filesystem to access files stored inside of ipfs.
|
package fuse/readonly implements a fuse filesystem to access files stored inside of ipfs. |
|
Package namesys implements resolvers and publishers for the IPFS naming system (IPNS).
|
Package namesys implements resolvers and publishers for the IPFS naming system (IPNS). |
|
Package pin implements structures and methods to keep track of which objects a user wants to keep stored locally.
|
Package pin implements structures and methods to keep track of which objects a user wants to keep stored locally. |
|
gc
Package gc provides garbage collection for go-ipfs.
|
Package gc provides garbage collection for go-ipfs. |
|
fsrepo
package fsrepo
|
package fsrepo |
|
test
|
|
|
thirdparty
|
|
|
notifier
Package notifier provides a simple notification dispatcher meant to be embedded in larger structres who wish to allow clients to sign up for event notifications.
|
Package notifier provides a simple notification dispatcher meant to be embedded in larger structres who wish to allow clients to sign up for event notifications. |
|
pollEndpoint
pollEndpoint is a helper utility that waits for a http endpoint to be reachable and return with http.StatusOK
|
pollEndpoint is a helper utility that waits for a http endpoint to be reachable and return with http.StatusOK |
Click to show internal directories.
Click to hide internal directories.