Skip to content

GitLab

Commit 9ade2109 authored by Richard Littauer's avatar Richard Littauer
Browse files
Options

Cleaned up README 

I did the following:
- Capitalized IPFS wherever it did not explicitely refer to the CLI command
- Moved Dev Dependencies into the Install section
- Added a Table of Contents
- Capitalised and added periods to various sentences
- Capitalised Go
- Removed double empty lines
- Reindented a few sections to make the flow more clear.
- Added a note to the Install section about how to canonically install.

License: MIT
Signed-off-by: default avatarRichard Littauer <richard.littauer@gmail.com>
parent ce0d62dc
Hide whitespace changes
Inline Side-by-side
Showing with 56 additions and 39 deletions
README.md
View file @ 9ade2109
# ipfs implementation in go. # IPFS implementation in Go
[![GoDoc](https://godoc.org/github.com/ipfs/go-ipfs?status.svg)](https://godoc.org/github.com/ipfs/go-ipfs) [![Build Status](https://travis-ci.org/ipfs/go-ipfs.svg?branch=master)](https://travis-ci.org/ipfs/go-ipfs) [![GoDoc](https://godoc.org/github.com/ipfs/go-ipfs?status.svg)](https://godoc.org/github.com/ipfs/go-ipfs) [![Build Status](https://travis-ci.org/ipfs/go-ipfs.svg?branch=master)](https://travis-ci.org/ipfs/go-ipfs)
Ipfs is a global, versioned, peer-to-peer filesystem. It combines good ideas from 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, 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 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. with permanence built in. You can also mount the world at /ipfs.
For more info see: https://github.com/ipfs/ipfs For more info see: https://github.com/ipfs/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/ipfs/ipfs/issues). [ipfs repo issues](https://github.com/ipfs/ipfs/issues).
Please put all issues regarding go IPFS _implementation_ in [this repo](https://github.com/ipfs/go-ipfs/issues). Please put all issues regarding Go IPFS _implementation_ in [this repo](https://github.com/ipfs/go-ipfs/issues).
## Table of Contents
- [Security Issues](#security-issues)
- [Install](#install)
- [Install prebuilt packages](#install-prebuilt-packages)
- [Build from Source](#build-from-source)
- [Prerequisite: Install Go](#prerequisite-install-go)
- [Download + Compile IPFS](#download--compile-ipfs)
- [Development Dependencies](#development-dependencies)
- [Updating](#updating)
- [Usage](#usage)
- [Getting Started](#getting-started)
- [Some things to try](#some-things-to-try)
- [Docker usage](#docker-usage)
- [Docker usage with VirtualBox/boot2docker (OSX and Windows)](#docker-usage-with-virtualboxboot2docker-osx-and-windows)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
- [Todo](#todo)
- [License](#license)
## Security Issues ## Security Issues
...@@ -22,9 +42,9 @@ If the issue is a protocol weakness that cannot be immediately exploited or some ...@@ -22,9 +42,9 @@ If the issue is a protocol weakness that cannot be immediately exploited or some
## Install ## Install
The canonical download instructions for IPFS are over at: http://ipfs.io/docs/install/ The canonical download instructions for IPFS are over at: http://ipfs.io/docs/install/. It is **highly suggested** you follow those instructions if you are not interested in working on IPFS development.
## Install prebuilt packages ### Install prebuilt packages
We use [gobuilder.me](https://gobuilder.me), a great service that automatically builds a release on every commit. We use [gobuilder.me](https://gobuilder.me), a great service that automatically builds a release on every commit.
...@@ -34,26 +54,26 @@ You can see the latest builds for your platform at these links: ...@@ -34,26 +54,26 @@ You can see the latest builds for your platform at these links:
- [`master` - development, stable](https://gobuilder.me/github.com/ipfs/go-ipfs/cmd/ipfs?branch=master) - [`master` - development, stable](https://gobuilder.me/github.com/ipfs/go-ipfs/cmd/ipfs?branch=master)
From there: From there:
- click "Download" on the build for your platform - Click "Download" on the build for your platform.
- open/extract the archive - Open/extract the archive.
- move `ipfs` to your path (`install.sh` can do it for you) - Move `ipfs` to your path (`install.sh` can do it for you),
### Build from Source
## Build from Source #### Prerequisite: Install Go
### Prerequisite: Install Go First, you'll need Go. If you don't have it: [Download Go 1.5.2+](https://golang.org/dl/).
First, you'll need go. If you don't have it: [Download Go 1.5.2+](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`: 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:/usr/local/go/bin
export PATH=$PATH:$GOPATH/bin export PATH=$PATH:$GOPATH/bin
``` ```
(If you run into trouble, see the [Go install instructions](https://golang.org/doc/install)) (If you run into trouble, see the [Go install instructions](https://golang.org/doc/install)).
### Download + Compile IPFS #### Download + Compile IPFS
Then: Then:
...@@ -71,17 +91,21 @@ all dependencies. ...@@ -71,17 +91,21 @@ all dependencies.
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/ipfs/go-ipfs/issues/177) (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 * 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. * 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 [init examples](https://github.com/ipfs/examples/tree/master/examples/init) for how to connect IPFS to systemd or whatever init system your distro uses. * See the [init examples](https://github.com/ipfs/examples/tree/master/examples/init) for how to connect IPFS to systemd or whatever init system your distro uses.
### Updating ### Development Dependencies
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 If you make changes to the protocol buffers, you will need to install the [protoc compiler](https://github.com/google/protobuf).
codebase. To install ipfs update, either [download it here](https://gobuilder.me/github.com/ipfs/ipfs-update)
## Updating
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`, either [download it here](https://gobuilder.me/github.com/ipfs/ipfs-update)
or install it from source with `go get -u github.com/ipfs/ipfs-update`. or install it from source with `go get -u github.com/ipfs/ipfs-update`.
## Usage ## Usage
...@@ -96,7 +120,7 @@ USAGE: ...@@ -96,7 +120,7 @@ USAGE:
BASIC COMMANDS BASIC COMMANDS
init Initialize ipfs local configuration init Initialize ipfs local configuration
add <path> Add a file to ipfs add <path> Add an object to ipfs
cat <ref> Show ipfs object data cat <ref> Show ipfs object data
get <ref> Download ipfs objects get <ref> Download ipfs objects
ls <ref> List links from an object ls <ref> List links from an object
...@@ -143,7 +167,7 @@ USAGE: ...@@ -143,7 +167,7 @@ USAGE:
See also: http://ipfs.io/docs/getting-started/ See also: http://ipfs.io/docs/getting-started/
To start using ipfs, you must first initialize ipfs's config files on your 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 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 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!
...@@ -161,15 +185,15 @@ Basic proof of 'ipfs working' locally: ...@@ -161,15 +185,15 @@ Basic proof of 'ipfs working' locally:
### Docker usage ### Docker usage
An ipfs docker image is hosted at [hub.docker.com/r/jbenet/go-ipfs](https://hub.docker.com/r/jbenet/go-ipfs/). An IPFS docker image is hosted at [hub.docker.com/r/jbenet/go-ipfs](https://hub.docker.com/r/jbenet/go-ipfs/).
To make files visible inside the container you need to mount a host directory 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 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 import/export files from IPFS. You should also choose a directory to store
ipfs files that will persist when you restart the container. IPFS files that will persist when you restart the container.
export ipfs_staging=</absolute/path/to/somewhere/> export ipfs_staging=</absolute/path/to/somewhere/>
export ipfs_data=</absolute/path/to/somewhere_else/> export ipfs_data=</absolute/path/to/somewhere_else/>
Make sure docker can access these folders: Make sure docker can access these folders:
sudo chmod -R 777 /absolute/path/to/somewhere/ sudo chmod -R 777 /absolute/path/to/somewhere/
...@@ -188,7 +212,7 @@ Wait for ipfs to start. ipfs is running when you see: ...@@ -188,7 +212,7 @@ Wait for ipfs to start. ipfs is running when you see:
Gateway (readonly) server Gateway (readonly) server
listening on /ip4/0.0.0.0/tcp/8080 listening on /ip4/0.0.0.0/tcp/8080
(you can now stop watching the log) You can now stop watching the log.
Run ipfs commands: Run ipfs commands:
...@@ -198,7 +222,6 @@ For example: connect to peers ...@@ -198,7 +222,6 @@ For example: connect to peers
docker exec ipfs_host ipfs swarm peers docker exec ipfs_host ipfs swarm peers
Add files: Add files:
cp -r <something> $ipfs_staging cp -r <something> $ipfs_staging
...@@ -211,16 +234,15 @@ Stop the running container: ...@@ -211,16 +234,15 @@ Stop the running container:
#### Docker usage with VirtualBox/boot2docker (OSX and Windows) #### Docker usage with VirtualBox/boot2docker (OSX and Windows)
Since docker is running in the boot2docker VM, you need to forward Since docker is running in the boot2docker VM, you need to forward
relevant ports from the VM to your host for ipfs act normally. This is relevant ports from the VM to your host for IPFS to act normally. This is
accomplished with the following command: accomplished with the following command:
boot2docker ssh -L 5001:localhost:5001 -L 4001:localhost:4001 -L 8080:localhost:8080 -fN boot2docker ssh -L 5001:localhost:5001 -L 4001:localhost:4001 -L 8080:localhost:8080 -fN
### Troubleshooting ### Troubleshooting
If you have previously installed ipfs before and you are running into 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 ipfs config directory (~/.ipfs by default) and rerunning `ipfs init`. 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 This will reinitialize the config file to its defaults and clear out the local
datastore of any bad entries. datastore of any bad entries.
...@@ -228,18 +250,13 @@ For any other problems, check the [issues list](https://github.com/ipfs/go-ipfs/ ...@@ -228,18 +250,13 @@ For any other problems, check the [issues list](https://github.com/ipfs/go-ipfs/
and if you dont see your problem there, either come talk to us on irc (freenode #ipfs) or and if you dont see your problem there, either come talk to us on irc (freenode #ipfs) or
file an issue of your own! file an issue of your own!
## Contributing ## Contributing
Please see [Contribute.md](contribute.md)! Please see [Contribute.md](contribute.md)!
## Todo ## Todo
An IPFS alpha version has been released in February 2015. Things left to be done are all marked as [Issues](https://github.com/ipfs/go-ipfs/issues) An IPFS alpha version has been released in February 2015. Things left to be done are all marked as [issues](https://github.com/ipfs/go-ipfs/issues).
## Development Dependencies
If you make changes to the protocol buffers, you will need to install the [protoc compiler](https://github.com/google/protobuf).
## License ## License
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment