README
¶
Storj V3 Network
Storj is building a decentralized cloud storage network. Check out our white paper for more info!
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
Contributing to Storj
All of our code for Storj v3 is open source. Have a code change you think would make Storj better? Please send a pull request along! Make sure to sign our Contributor License Agreement (CLA) first. See our license section for more details.
Have comments or bug reports? Want to propose a PR before hand-crafting it? Jump on to our forum and join the Engineering Discussions to say hi to the developer community and to talk to the Storj core team.
Want to vote on or suggest new features? Post it on ideas.storj.io.
Issue tracking and roadmap
See the breakdown of what we're building by checking out the following resources:
Install required packages
To get started running Storj locally, download and install the latest release of Go (at least Go 1.13) at golang.org.
You will also need Git. (brew install git, apt-get install git, etc).
If you're building on Windows, you also need to install and have gcc setup correctly.
We support Linux, Mac, and Windows operating systems. Other operating systems supported by Go should also be able to run Storj.
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.
First, fork our repo and clone your copy of our repository.
git clone git@github.com:<your-username>/storj storj
cd storj
Then, let's install Storj.
go install -v ./cmd/...
Make changes and test
Make the changes you want to see! Once you're done, you can run all of the unit tests:
go test -v ./...
You can also execute only a single test package if you like. For example:
go test ./pkg/identity. Add -v for more informations about the executed unit
tests.
Push up a pull request
Use Git to push your changes to your fork:
git commit -a -m 'my changes!'
git push origin master
Use Github to open a pull request!
Start using Storj
Our wiki has documentation and tutorials. Check out these three tutorials:
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 our community forum or email us at support@tardigrade.io.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package certificate is responsible for managing certificate signing operations on peer identities' certificate chains.
|
Package certificate is responsible for managing certificate signing operations on peer identities' certificate chains. |
|
authorization
Package authorization is used for managing one-time-use certificate-signing- authorizations and claims.
|
Package authorization is used for managing one-time-use certificate-signing- authorizations and claims. |
|
certificateclient
Package certificateclient contains the client for the certificate endpoint.
|
Package certificateclient contains the client for the certificate endpoint. |
|
cmd
|
|
|
internal/asset
Package asset implements asset embedding via implementing http.FileSystem interface.
|
Package asset implements asset embedding via implementing http.FileSystem interface. |
|
examples
|
|
|
lib
|
|
|
uplink
Package uplink is the main entrypoint to interacting with Storj Labs' decentralized storage network.
|
Package uplink is the main entrypoint to interacting with Storj Labs' decentralized storage network. |
|
uplink-gomobile
Package mobile contains the simplified mobile APIs to Storj Network.
|
Package mobile contains the simplified mobile APIs to Storj Network. |
|
pkg
|
|
|
debug
Package debug implements debug server for satellite and storage node.
|
Package debug implements debug server for satellite and storage node. |
|
private
|
|
|
context2
Package context2 contains utilities for contexts.
|
Package context2 contains utilities for contexts. |
|
date
Package date contains various date-related utilities
|
Package date contains various date-related utilities |
|
dbutil/dbschema
Package dbschema package implements querying and comparing schemas for testing.
|
Package dbschema package implements querying and comparing schemas for testing. |
|
dbutil/pgutil
Package pgutil contains utilities for postgres
|
Package pgutil contains utilities for postgres |
|
dbutil/txutil
Package txutil provides safe transaction-encapsulation functions which have retry semantics as necessary.
|
Package txutil provides safe transaction-encapsulation functions which have retry semantics as necessary. |
|
lifecycle
Package lifecycle allows controlling group of items.
|
Package lifecycle allows controlling group of items. |
|
tagsql
Package tagsql implements a tagged wrapper for databases.
|
Package tagsql implements a tagged wrapper for databases. |
|
testplanet
Package testplanet implements the full network wiring for testing
|
Package testplanet implements the full network wiring for testing |
|
testuplink
Package testuplink contains integration tests for storj.io/uplink
|
Package testuplink contains integration tests for storj.io/uplink |
|
accounting/live
Package live provides live accounting functionality.
|
Package live provides live accounting functionality. |
|
admin
Package admin implements administrative endpoints for satellite.
|
Package admin implements administrative endpoints for satellite. |
|
attribution
Package attribution implements value attribution from docs/design/value-attribution.md
|
Package attribution implements value attribution from docs/design/value-attribution.md |
|
gc
Package gc contains the functions needed to run garbage collection.
|
Package gc contains the functions needed to run garbage collection. |
|
postgreskv/schema
Code generated for package schema by go-bindata DO NOT EDIT.
|
Code generated for package schema by go-bindata DO NOT EDIT. |
|
redis/redisserver
Package redisserver is package for starting a redis test server
|
Package redisserver is package for starting a redis test server |
|
bandwidth
Package bandwidth implements bandwidth usage rollup loop.
|
Package bandwidth implements bandwidth usage rollup loop. |
|
collector
Package collector implements expired piece deletion from storage node.
|
Package collector implements expired piece deletion from storage node. |
|
testsuite
module
|
|
|
playwright-ui
Module
|
|
|
storjscan
Module
|
|
|
ui
Module
|
|