Go to file
Bryan White d737a776bf update readme
(cherry picked from commit 7a79a72db0c54142c18fc12ff5eb7280896ea92a)
2018-04-17 11:30:15 -04:00
api keep 2018-04-06 12:36:55 -04:00
assets keep 2018-04-06 12:36:55 -04:00
build keep 2018-04-06 12:36:55 -04:00
cmd Light client implementation with get-info and list-buckets commands (#2) 2018-04-16 16:42:06 +03:00
configs keep 2018-04-06 12:36:55 -04:00
deployments keep 2018-04-06 12:36:55 -04:00
dev add dev directory for tracking dev dependencies via vgo 2018-04-17 11:30:14 -04:00
docs Add error handling section 2018-04-11 07:43:23 -05:00
examples keep 2018-04-06 12:36:55 -04:00
githooks keep 2018-04-06 12:36:55 -04:00
init keep 2018-04-06 12:36:55 -04:00
internal Light client implementation with get-info and list-buckets commands (#2) 2018-04-16 16:42:06 +03:00
logo wip on structure 2018-04-06 12:32:34 -04:00
pkg fix import to storj 2018-04-16 10:09:01 -06:00
protos overlay proto 2018-04-16 10:09:01 -06:00
routes wip on structure 2018-04-06 12:32:34 -04:00
scripts grpc server and client 2018-04-16 10:09:01 -06:00
storage/boltdb wip on structure 2018-04-06 12:32:34 -04:00
test keep 2018-04-06 12:36:55 -04:00
third_party keep 2018-04-06 12:36:55 -04:00
tools keep 2018-04-06 12:36:55 -04:00
web keep 2018-04-06 12:36:55 -04:00
.gitignore overlay proto 2018-04-16 10:09:01 -06:00
go.mod Light client implementation with get-info and list-buckets commands (#2) 2018-04-16 16:42:06 +03:00
LICENSE.md wip on structure 2018-04-06 12:32:34 -04:00
Makefile grpc server and client 2018-04-16 10:09:01 -06:00
README.md update readme 2018-04-17 11:30:15 -04:00

Storj

Go Report Card Go Doc Release


Storj is a platform, cryptocurrency, 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 decentralized network of computers around the globe. No one but you has a complete copy of your file, not even in an ecrypted form.


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 VGO

go get -u golang.org/x/vgo

Install non-go development dependencies

In order to develop on storj, you will need to have the protobuf compiler installed on your system.

  1. Grab the latest release for your system from here

  2. place the protoc binary in your path. i.e

    mv $HOME/Downloads/protoc-<version>-<arch>/bin/protoc /usr/local/bin
    

Install go dependencies

Use vgo to install both dev and non-dev dependencies

  1. Install development dependencies

    # shouldn't change your pwd
    (cd ./dev && vgo install)
    
  2. Install project dependencies

    # in project root
    vgo install
    

If you want to build storj right away there are two options:

You have a working Go environment.
$ go get -d storj.io/storj
$ cd $GOPATH/src/storj.io/storj
$ make
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 questions, reach out to us twitter.