7812f1bbc0
* initial commit- wip, working on testing and library * wip working on testing library functioon to get poointer * working on nil reference for testing * tests wip * wip-working on getting tests to work * working on tests * put test passes * working on test- need to export * created pdclient, and now working on testing function * tests working for list- getting object back * wip - got derived piece id * fixed making grpc public * fixed linter errors and minor added method for size * need to work on testing, added random integer function * got psc server working for testing * working on ranger test and ranger method * testing creds for new computer * working on getting segment metadata * get random stripe * added caveat to random fn * fixed data types * modified library to have one public function that returns a random stripe * removed extra comments * added commons.go file for audit * added last path to be remembered * changed random function to cryto/rand/ & worked on tests passing * working on testing to get analysis of randomness * changed to track last item in pagination * finished testing randomness, cleaned up code * fixed rebase errors * removed error, kept common file * fixed travis errors * attempt to fix overlay issue * fixed travis error * updated pointer parameters * made smaller functions, renamed audit * made changes per suggestions * removed gosum * fixed pr per suggestions * removed comment |
||
|---|---|---|
| cmd | ||
| examples | ||
| internal | ||
| logo | ||
| pkg | ||
| scripts | ||
| storage | ||
| test | ||
| .clabot | ||
| .dockerignore | ||
| .gitignore | ||
| .golangci.yml | ||
| .travis.yml | ||
| all-in-one.md | ||
| CODE_OF_CONDUCT.md | ||
| docker-compose.yaml | ||
| go.mod | ||
| Gopkg.lock | ||
| Gopkg.toml | ||
| Jenkinsfile | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
Storj V3 Network
Storj is building a decentralized cloud storage network and is launching in early 2019.
Storj is an S3 compatible platform and suite of decentralized applications that allows you to store data in a secure and decentralized manner. Your files are encrypted, broken into little pieces and stored in a global decentralized network of computers. Luckily, we also support allowing you (and only you) to retrieve those files!
Table of Contents
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 GOPATHentirely, or setGO111MODULE=onbefore 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
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.
Start 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.yamlwith 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
Start 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]:
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
License
The network under construction (this repo) is currently licensed with the AGPLv3 license. Once the network reaches beta phase, we will be licensing all client-side code via the Apache v2 license.
For code released under the AGPLv3, we request that contributors sign our Contributor License Agreement (CLA) so that we can relicense the code under Apache v2, or other licenses in the future.
Support
If you have any questions or suggestions please reach out to us on Rocketchat or Twitter.