storj/README.md

105 lines
3.3 KiB
Markdown
Raw Normal View History

2018-04-06 17:38:32 +01:00
# Storj
2018-04-06 17:32:34 +01:00
[![Go Report Card](https://goreportcard.com/badge/github.com/storj/storj)](https://goreportcard.com/report/github.com/storj/storj)
2018-04-06 17:32:34 +01:00
[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/storj/storj)
[![Coverage Status](https://coveralls.io/repos/github/storj/storj/badge.svg?branch=master)](https://coveralls.io/github/storj/storj?branch=master)
2018-04-06 17:32:34 +01:00
2018-08-06 18:39:20 +01:00
<img src="https://github.com/storj/storj/raw/master/logo/logo.png" width="100">
2018-04-06 17:32:34 +01:00
2018-07-29 19:53:27 +01:00
Storj is in the midst of a rearchitecture. Please stay tuned for our v3 whitepaper!
2018-04-06 17:32:34 +01:00
----
2018-07-29 19:53:27 +01:00
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 and stored in a global decentralized network of computers. Luckily, we also support allowing you (and only you) to recover them!
2018-04-06 17:32:34 +01:00
2018-07-27 17:29:45 +01:00
## To start developing
2018-04-06 17:32:34 +01:00
### Install required packages
2018-04-17 14:38:31 +01:00
2018-07-27 17:29:45 +01:00
First of all, install `git` and `golang`.
2018-04-17 14:38:31 +01:00
#### Debian based (like Ubuntu)
```bash
2018-07-27 17:29:45 +01:00
apt-get install git golang
2018-08-01 22:18:09 +01:00
echo 'export STORJDEV="$HOME/storj"' >> $HOME/.bashrc
echo 'export GOPATH="$STORJDEV:$STORJDEV/vendor"' >> $HOME/.bashrc
echo 'export PATH="$PATH:$STORJDEV/bin"' >> $HOME/.bashrc
source $HOME/.bashrc
```
#### Mac OSX
```bash
2018-07-27 17:29:45 +01:00
brew install git go
if test -e $HOME/.bash_profile
then
2018-08-01 22:18:09 +01:00
echo 'export STORJDEV="$HOME/storj"' >> $HOME/.bash_profile
echo 'export GOPATH="$STORJDEV:$STORJDEV/vendor"' >> $HOME/.bash_profile
echo 'export PATH="$PATH:$STORJDEV/bin"' >> $HOME/.bash_profile
source $HOME/.bash_profile
else
2018-08-01 22:18:09 +01:00
echo 'export STORJDEV="$HOME/storj"' >> $HOME/.profile
echo 'export GOPATH="$STORJDEV:$STORJDEV/vendor"' >> $HOME/.profile
echo 'export PATH="$PATH:$STORJDEV/bin"' >> $HOME/.profile
source $HOME/.profile
fi
```
2018-04-17 14:38:31 +01:00
### Install storj
Clone the storj repository. You may want to clone your own fork and branch.
```bash
2018-08-01 22:18:09 +01:00
mkdir -p $STORJDEV/src/storj.io
git clone https://github.com/storj/storj $STORJDEV/src/storj.io/storj
```
#### Install all dependencies
```bash
2018-08-01 22:18:09 +01:00
git clone --recursive https://github.com/storj/storj-vendor $STORJDEV/vendor
rm -rf $STORJDEV/vendor/src/github.com/minio/minio/vendor/github.com/minio/cli
2018-08-03 19:33:53 +01:00
rm -rf $STORJDEV/vendor/src/github.com/minio/minio/vendor/golang.org/x/net/trace
```
### Run unit tests
```bash
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.
2018-04-06 17:32:34 +01:00
2018-07-27 17:29:45 +01:00
### Start the network
2018-04-06 17:32:34 +01:00
```bash
2018-07-31 18:13:32 +01:00
$ go install -v storj.io/storj/cmd/captplanet
$ captplanet setup
$ captplanet run
```
2018-07-31 18:13:55 +01:00
### Configure AWS CLI
2018-07-31 18:13:32 +01:00
2018-08-01 22:18:09 +01:00
Download and install the AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/installing.html
2018-07-31 18:13:32 +01:00
```bash
$ aws configure
AWS Access Key ID [None]: insecure-dev-access-key
AWS Secret Access Key [None]: insecure-dev-secret-key
Default region name [None]: us-east-1
Default output format [None]:
$ aws configure set default.s3.multipart_threshold 1TB # until we support multipart
```
### Do an upload
```bash
$ aws s3 --endpoint=http://localhost:7777/ cp large-file s3://bucket/large-file
2018-04-06 17:32:34 +01:00
```
## Support
2018-08-01 22:18:09 +01:00
If you have any questions or suggestions please reach out to us on [Rocketchat](https://community.storj.io/) or [Twitter](https://twitter.com/storjproject).