README
¶
FrostFS is a decentralized distributed object storage integrated with the NEO Blockchain.
Overview
FrostFS Nodes are organized in a peer-to-peer network that takes care of storing and distributing user's data. Any Neo user may participate in the network and get paid for providing storage resources to other users or store their data in FrostFS and pay a competitive price for it.
Users can reliably store object data in the FrostFS network and have a transparent data placement process due to a decentralized architecture and flexible storage policies. Each node is responsible for executing the storage policies that the users select for geographical location, reliability level, number of nodes, type of disks, capacity, etc. Thus, FrostFS gives full control over data to users.
Deep Neo Blockchain integration allows FrostFS to be used by dApps directly from NeoVM on the Smart Contract code level. This way dApps are not limited to on-chain storage and can manipulate large amounts of data without paying a prohibitive price.
FrostFS has a native gRPC API and has protocol gateways for popular protocols such as AWS S3, HTTP, FUSE and sFTP allowing developers to integrate applications without rewriting their code.
Supported platforms
Now, we only support GNU/Linux on amd64 CPUs with AVX/AVX2 instructions. More
platforms will be officially supported after release 1.0.
The latest version of frostfs-node works with frostfs-contract v0.16.0.
Building
To make all binaries you need Go 1.18+ and make:
make all
The resulting binaries will appear in bin/ folder.
To make a specific binary use:
make bin/frostfs-<name>
See the list of all available commands in the cmd folder.
Building with Docker
Building can also be performed in a container:
make docker/all # build all binaries
make docker/bin/frostfs-<name> # build a specific binary
Docker images
To make docker images suitable for use in frostfs-dev-env use:
make images
Contributing
Feel free to contribute to this project after reading the contributing guidelines.
Before starting to work on a certain topic, create a new issue first, describing the feature/topic you are going to implement.
Credits
FrostFS is maintained by True Cloud Lab with the help and contributions from community members.
Please see CREDITS for details.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
frostfs-cli/internal/client
Package internal provides functionality for FrostFS CLI application communication with FrostFS network.
|
Package internal provides functionality for FrostFS CLI application communication with FrostFS network. |
|
frostfs-node/reputation/internal/client
Package internal provides functionality for FrostFS Node Reputation system communication with FrostFS network.
|
Package internal provides functionality for FrostFS Node Reputation system communication with FrostFS network. |
|
pkg
|
|
|
innerring/internal/client
Package frostfsapiclient provides functionality for IR application communication with FrostFS network.
|
Package frostfsapiclient provides functionality for IR application communication with FrostFS network. |
|
innerring/processors/netmap/nodevalidation/state
Package state collects functionality for verifying states of network map members.
|
Package state collects functionality for verifying states of network map members. |
|
local_object_storage/writecache
Package writecache implements write-cache for objects.
|
Package writecache implements write-cache for objects. |
|
services/object/internal/client
Package internal provides functionality for FrostFS Node Object service communication with FrostFS network.
|
Package internal provides functionality for FrostFS Node Object service communication with FrostFS network. |