Go to file
Meije Sibbel 86a2371961
update readme
1. Fixed a few spelling issues.
2. Added capital letter to the Storj name instead of a lowercase one. 
3. Reformulated some sentences. 
3. Some other small fixes.
2018-04-27 14:53:46 +02: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
docs Add error handling section 2018-04-11 07:43:23 -05:00
examples pkg/ranger: FileRanger (#18) 2018-04-23 20:16:34 -06:00
githooks keep 2018-04-06 12:36:55 -04:00
init keep 2018-04-06 12:36:55 -04:00
internal HTTP Ranger (#11) 2018-04-17 07:39:14 -06:00
logo wip on structure 2018-04-06 12:32:34 -04:00
pkg Do not fail decoding on first read error (#17) 2018-04-23 20:17:50 -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 lint step for copyright headers (#16) 2018-04-23 10:05:52 -06:00
storage fixing import 2018-04-23 09:54:00 -06: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 lint step for copyright headers (#16) 2018-04-23 10:05:52 -06:00
README.md update readme 2018-04-27 14:53:46 +02:00

Storj

Go Report Card Go Doc Release


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 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

    make build-dev-deps
    
  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 any questions or suggestions please reach out to us on rocketchat or twitter.