mirror of
https://github.com/ipfs/kubo.git
synced 2025-09-11 23:46:39 +08:00
work on readme
This commit is contained in:
31
README.md
31
README.md
@ -1,6 +1,12 @@
|
|||||||
# ipfs implementation in go. [](https://godoc.org/github.com/jbenet/go-ipfs) [](https://travis-ci.org/jbenet/go-ipfs)
|
# ipfs implementation in go.
|
||||||
|
[](https://godoc.org/github.com/jbenet/go-ipfs) [](https://travis-ci.org/jbenet/go-ipfs)
|
||||||
|
|
||||||
See: https://github.com/jbenet/ipfs
|
Ipfs is a global, versioned, peer-to-peer filesystem. It combines good ideas from
|
||||||
|
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://github.com/jbenet/ipfs
|
||||||
|
|
||||||
Please put all issues regarding IPFS _design_ in the
|
Please put all issues regarding IPFS _design_ in the
|
||||||
[ipfs repo issues](https://github.com/jbenet/ipfs/issues).
|
[ipfs repo issues](https://github.com/jbenet/ipfs/issues).
|
||||||
@ -18,13 +24,13 @@ go install
|
|||||||
|
|
||||||
NOTES:
|
NOTES:
|
||||||
|
|
||||||
* `git` and mercurial (`hg`) are required in order for `go get` to fetch
|
* `git` is required in order for `go get` to fetch
|
||||||
all dependencies.
|
all dependencies.
|
||||||
* Package managers often contain out-of-date `golang` packages.
|
* Package managers often contain out-of-date `golang` packages.
|
||||||
Compilation from source is recommended.
|
Compilation from source is recommended.
|
||||||
* If you are interested in development, please install the development
|
* If you are interested in development, please install the development
|
||||||
dependencies as well.
|
dependencies as well.
|
||||||
* **WARNING: older versions of OSX FUSE (for Mac OS X) can cause kernel panics when mounting!**
|
* *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/).
|
We strongly recommend you use the [latest version of OSX FUSE](http://osxfuse.github.io/).
|
||||||
(See https://github.com/jbenet/go-ipfs/issues/177)
|
(See https://github.com/jbenet/go-ipfs/issues/177)
|
||||||
|
|
||||||
@ -70,13 +76,28 @@ system, this is done with `ipfs init`. See `ipfs help init` for information on
|
|||||||
the optional arguments it takes. After initialization is complete, you can use
|
the optional arguments it takes. After initialization is complete, you can use
|
||||||
`ipfs mount`, `ipfs add` and any of the other commands to explore!
|
`ipfs mount`, `ipfs add` and any of the other commands to explore!
|
||||||
|
|
||||||
|
### Some things to try
|
||||||
|
|
||||||
NOTE: if you have previously installed ipfs before and you are running into
|
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 <that hash>
|
||||||
|
|
||||||
|
|
||||||
|
### 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
|
problems getting a newer version to work, try deleting (or backing up somewhere
|
||||||
else) your config directory (~/.go-ipfs by default) and rerunning `ipfs init`.
|
else) your config directory (~/.go-ipfs by default) and rerunning `ipfs init`.
|
||||||
This will reinitialize the config file to its defaults and clear out the local
|
This will reinitialize the config file to its defaults and clear out the local
|
||||||
datastore of any bad entries.
|
datastore of any bad entries.
|
||||||
|
|
||||||
|
For any other problems, check the [issues list](http://github.com/jbenet/go-ipfs/issues)
|
||||||
|
and if you dont see your problem there, either come talk to us on irc (freenode #ipfs) or
|
||||||
|
file an issue of your own!
|
||||||
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user