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 the forum.
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 main
Use Github to open a pull request!
A Note about Versioning
While we are practicing semantic versioning for our client libraries such as uplink, we are not practicing semantic versioning in this repo, as we do not intend for it to be used via Go modules. We may have backwards-incompatible changes between minor and patch releases in this repo.
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 file a ticket at https://support.storj.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. |
|
certificatepb
Package certificatepb contains protobuf definitions for certificate signing.
|
Package certificatepb contains protobuf definitions for certificate signing. |
|
cmd
|
|
|
internal/asset
Package asset implements asset embedding via implementing http.FileSystem interface.
|
Package asset implements asset embedding via implementing http.FileSystem interface. |
|
gateway
Module
|
|
|
private
|
|
|
crashreportpb
Package crashreportpb contains protobuf definitions for crashreport.
|
Package crashreportpb contains protobuf definitions for crashreport. |
|
date
Package date contains various date-related utilities
|
Package date contains various date-related utilities |
|
lifecycle
Package lifecycle allows controlling group of items.
|
Package lifecycle allows controlling group of items. |
|
multinodepb
Package multinodepb contains protobuf definitions for storagenode multinode dashboard.
|
Package multinodepb contains protobuf definitions for storagenode multinode dashboard. |
|
prompt
Package prompt implements asking input from command line.
|
Package prompt implements asking input from command line. |
|
testplanet
Package testplanet implements the full network wiring for testing
|
Package testplanet implements the full network wiring for testing |
|
testredis
Package testredis is package for starting a redis test server
|
Package testredis is package for starting a redis test server |
|
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. |
|
internalpb
Package internalpb contains proto definitions for satellite internal tools.
|
Package internalpb contains proto definitions for satellite internal tools. |
|
metabase
Package metabase implements storing objects and segements.
|
Package metabase implements storing objects and segements. |
|
metainfo/expireddeletion
Package expireddeletion contains the functions needed to run expired segment deletion The expireddeletion.expiredDeleter implements the metainfo loop Observer interface allowing us to subscribe to the loop to get information for every segment in the metainfo database.
|
Package expireddeletion contains the functions needed to run expired segment deletion The expireddeletion.expiredDeleter implements the metainfo loop Observer interface allowing us to subscribe to the loop to get information for every segment in the metainfo database. |
|
metainfo/piecedeletion
Package piecedeletion implements service for deleting pieces that combines concurrent requests.
|
Package piecedeletion implements service for deleting pieces that combines concurrent requests. |
|
metainfo/pointerverification
Package pointerverification implements verification of pointers.
|
Package pointerverification implements verification of pointers. |
|
nodeselection
Package nodeselection implements node selection logic.
|
Package nodeselection implements node selection logic. |
|
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. |
|
internalpb
Package internalpb contains proto definitions for storagenode internal tools.
|
Package internalpb contains proto definitions for storagenode internal tools. |
|
piecetransfer
Package piecetransfer contains code meant to deal with transferring pieces from one node to another.
|
Package piecetransfer contains code meant to deal with transferring pieces from one node to another. |
|
testsuite
module
|
|
|
playwright-ui
Module
|
|
|
storjscan
Module
|
|
|
ui
Module
|
|