README
¶
Storj V3 Network
Storj is building a distributed cloud storage network. Check out our white paper for more info!
Storj is an S3-compatible platform and suite of distributed applications that allows you to store data in a secure and distributed manner. Your files are encrypted, broken into little pieces and stored in a global distributed 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. If anything feels off, or if you feel that some functionality is missing, please check out the contributing page. There you will find instructions for sharing your feedback, building the tool locally, and submitting pull requests to the project.
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
This repository is currently licensed with the AGPLv3 license.
For code released under the AGPLv3, we request that contributors sign our updated Contributor License Agreement (CLA) v2 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
|
|
|
uplink/ulext
Package ulext provides an interface for the CLI to interface with the external world.
|
Package ulext provides an interface for the CLI to interface with the external world. |
|
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. |
|
testmonkit
Package testmonkit allows attaching monkit monitoring for testing.
|
Package testmonkit allows attaching monkit monitoring for testing. |
|
testplanet
Package testplanet implements full network wiring for testing.
|
Package testplanet implements 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. |
|
admin/back-office
See LICENSE for copying information.
|
See LICENSE for copying information. |
|
admin/back-office/gen
Package main defines the satellite administration API through the API generator and generates source code of the API server handlers and clients and the documentation markdown document.
|
Package main defines the satellite administration API through the API generator and generates source code of the API server handlers and clients and the documentation markdown document. |
|
attribution
Package attribution implements value attribution from docs/design/value-attribution.md
|
Package attribution implements value attribution from docs/design/value-attribution.md |
|
durability
Package durability helps us to keep segments in healthy state with reporting risks.
|
Package durability helps us to keep segments in healthy state with reporting risks. |
|
gc
Package gc contains the functions needed to run garbage collection.
|
Package gc contains the functions needed to run garbage collection. |
|
gc/bloomfilter
Package bloomfilter contains the functions needed to run part of garbage collection process.
|
Package bloomfilter contains the functions needed to run part of garbage collection process. |
|
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. |
|
metabase/zombiedeletion
Package zombiedeletion contains the functions needed to run zombie objects deletion chore.
|
Package zombiedeletion contains the functions needed to run zombie objects deletion chore. |
|
metainfo/expireddeletion
Package expireddeletion contains the functions needed to run expired segment deletion
|
Package expireddeletion contains the functions needed to run expired segment deletion |
|
metainfo/pointerverification
Package pointerverification implements verification of pointers.
|
Package pointerverification implements verification of pointers. |
|
nodeselection
Package uploadselection implements node selection logic for uploads.
|
Package uploadselection implements node selection logic for uploads. |
|
oidc
Package oidc provides all the elements needed to support OAuth and OpenID Connect workflows using Storj as an identity provider and resource server.
|
Package oidc provides all the elements needed to support OAuth and OpenID Connect workflows using Storj as an identity provider and resource server. |
|
Package shared contains utilities which shared projects outside this repo (like edge).
|
Package shared contains utilities which shared projects outside this repo (like edge). |
|
lrucache
Package lrucache provides a LRU cache implementation with an optional key expiration time.
|
Package lrucache provides a LRU cache implementation with an optional key expiration time. |
|
bandwidth
Package bandwidth system keeps track of bandwidth usage as reported by order limits and orders.
|
Package bandwidth system keeps track of bandwidth usage as reported by order limits and orders. |
|
collector
Package collector implements expired piece deletion from storage node.
|
Package collector implements expired piece deletion from storage node. |
|
inspector
Package inspector provides a private endpoint for monitoring status.
|
Package inspector provides a private endpoint for monitoring status. |
|
internalpb
Package internalpb contains proto definitions for storagenode internal tools.
|
Package internalpb contains proto definitions for storagenode internal tools. |
|
monitor
Package monitor is responsible for monitoring the disk is well-behaved.
|
Package monitor is responsible for monitoring the disk is well-behaved. |
|
orders
Package orders handles order limit management.
|
Package orders handles order limit management. |
|
pieces
Package pieces is responsible for the low level piece management.
|
Package pieces is responsible for the low level piece management. |
|
piecestore
Package piecestore contains the endpoint for responding to requests from the uplinks and satellites.
|
Package piecestore contains the endpoint for responding to requests from the uplinks and satellites. |
|
trust
Package trust handles rules for accepting and denying connections from satellites.
|
Package trust handles rules for accepting and denying connections from satellites. |
|
testsuite
module
|
|
|
storjscan
Module
|
|
|
ui
Module
|
|
|
web
|
|
Click to show internal directories.
Click to hide internal directories.