littleskunk bda13f59e2 update install instructions (#130 )

* update install instructions

* different sections for different distros

2018-07-19 15:48:51 -04:00

3.5 KiB

Raw Blame History

Storj

Storj is a platform, token, and suite of decentralized applications that allows you to store data in a secure and decentralized manner. Your files are encrypted, shredded into little pieces called 'shards' and stored in a global decentralized network of computers. Only you have access and the ability to retrieve all shards from the network, decrypt them, and finally re-combine all file pieces into your original file.

To start using Storj

See our documentation at Storj docs.

To start developing Storj

The community site hosts all information about building storj from source, how to contribute code and documentation, who to contact about what, etc.

Install required packages

First of all install git, golang and redis-server and add environment variables.

Debian based (like Ubuntu)

apt-get install git golang redis-server
echo 'export GOPATH="$HOME/go"' >> $HOME/.bashrc
echo 'export PATH="$PATH:${GOPATH//://bin:}/bin"' >> $HOME/.bashrc
source $HOME/.bashrc

Mac OSX

brew install git go redis
if test -e $HOME/.bash_profile
then
	echo 'export GOPATH="$HOME/go"' >> $HOME/.bash_profile
	echo 'export PATH="$PATH:${GOPATH//://bin:}/bin"' >> $HOME/.bash_profile
	source $HOME/.bash_profile
else
	echo 'export GOPATH="$HOME/go"' >> $HOME/.profile
	echo 'export PATH="$PATH:${GOPATH//://bin:}/bin"' >> $HOME/.profile
	source $HOME/.profile
fi

Install storj

Clone the storj repository. You may want to clone your own fork and branch.

git clone https://github.com/storj/storj $GOPATH/src/storj.io/storj

Install all dependencies

go get can be used to install all dependencies. The execution will take some time. You can add -v if you want to get more feedback.

go get -t storj.io/storj/...

Fix error message cannot use "github.com/minio/cli" See https://github.com/minio/minio/issues/5974 for more details.

go get -t github.com/minio/cli && rm -rf $GOPATH/src/github.com/minio/minio/vendor/github.com/minio/cli
go get -t storj.io/storj/...

Run unit tests

go clean -testcache
go test storj.io/storj/...

You can execute only a single test package. For example: go test storj.io/storj/pkg/kademlia. Add -v for more informations about the executed unit tests.

Start farmer

piecestore-farmer --help

To be continued.

You have a working Docker environment.

$ git clone https://github.com/storj/storj
$ cd storj
$ make docker

For the full story, head over to the [developer's documentation].

Support

If you need support, start with the [troubleshooting guide], and work your way through the process that we've outlined.

That said, if you have any questions or suggestions please reach out to us on rocketchat or twitter.

3.5 KiB Raw Blame History