cmd | ||
docs | ||
examples | ||
internal | ||
logo | ||
pkg | ||
pointerdb/auth | ||
protos | ||
scripts | ||
static | ||
storage | ||
test | ||
.clabot | ||
.gitignore | ||
.travis.yml | ||
all-in-one.md | ||
CODE_OF_CONDUCT.md | ||
docker-compose.yaml | ||
go.mod | ||
go.sum | ||
Gopkg.lock | ||
Gopkg.toml | ||
index.html | ||
Jenkinsfile | ||
LICENSE | ||
Makefile | ||
README.md |
Storj V3 Network
Storj is in the midst of a rearchitecture. Please stay tuned for our v3 whitepaper!
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!
Table of Contents
Start Using Storj
Download, setup, and run the latest release
Go here to download the latest build
- TODO: add link when a build is released
- TODO for how to run the release
Using Storj via the Storj CLI
Configure the Storj CLI
- In a new terminal setup the Storj CLI:
$ storj setup
- Edit the API Key, overlay address, and pointer db address fields in the Storj
CLI config file located at
~/.storj/cli/config.yaml
with values from the captplanet config file located at~/.storj/capt/config.yaml
Test out some Storj CLI commands!
- Create a bucket:
$ storj mb s3://bucket-name
- Upload an object:
$ storj cp ~/Desktop/your-large-file.mp4 s3://bucket-name
- List objects in a bucket:
$ storj ls s3://bucket-name/
- Download an object:
$ storj cp s3://bucket-name/your-large-file.mp4 ~/Desktop/your-large-file.mp4
- Delete an object:
$ storj rm s3://bucket-name/your-large-file.mp4
Using Storj via the AWS S3 CLI
Configure AWS CLI
Download and install the AWS S3 CLI: https://docs.aws.amazon.com/cli/latest/userguide/installing.html
In a new terminal session configure the AWS S3 CLI:
$ 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
Test out some AWS S3 CLI commands!
- Create a bucket:
$ aws s3 --endpoint=http://localhost:7777/ mb s3://bucket-name
- Upload an object:
$ aws s3 --endpoint=http://localhost:7777/ cp ~/Desktop/your-large-file.mp4 s3://bucket-name
- List objects in a bucket:
$ aws s3 --endpoint=http://localhost:7777/ ls s3://bucket-name/
- Download an object:
$ aws s3 --endpoint=http://localhost:7777/ cp s3://bucket-name/your-large-file.mp4 ~/Desktop/your-large-file.mp4
- Generate a URL for an object:
$ aws s3 --endpoint=http://localhost:7777/ presign s3://bucket-name/your-large-file.mp4
- Delete an object:
$ aws s3 --endpoint=http://localhost:7777/ rm s3://bucket-name/your-large-file.mp4
For more information about the AWS s3 CLI visit: https://docs.aws.amazon.com/cli/latest/reference/s3/index.html
Start Contributing to Storj
Install required packages
Download and install the latest release of Go, at least Go 1.11: https://golang.org/
You will also need Git. (brew install git
, apt-get install git
, etc).
Install git and golang. We support Linux, Mac, and Windows operating systems. Other operating systems supported by Go are probably not much additional work.
Download and compile Storj
Aside about GOPATH: Go 1.11 supports a new feature called Go modules, and Storj has adopted Go module support. If you've used previous Go versions, Go modules no longer require a GOPATH environment variable. Go by default falls back to the old behavior if you check out code inside of the directory referenced by your GOPATH variable, so make sure to use another directory,
unset GOPATH
entirely, or setGO111MODULE=on
before continuing with these instructions. If you don't have a GOPATH set, you can ignore this aside.
git clone git@github.com:storj/storj storj
cd storj
go install -v ./cmd/...
Configure a test network
~/go/bin/captplanet setup
Start the test network
~/go/bin/captplanet run
Try out some commands via Storj CLI or AWS CLI
Run unit tests
go test -v ./...
You can execute only a single test package if you like. For example:
go test ./pkg/kademlia
. Add -v
for more informations about the executed unit
tests.
Support
If you have any questions or suggestions please reach out to us on Rocketchat or Twitter.