Add Features paragraph to README.md
This commit is contained in:
@@ -1,7 +1,24 @@
|
|||||||
# ToastyFS
|
# ToastyFS
|
||||||
ToastyFS is a distributed file system for personal use. It's designed to be pragmatic, understandable, and robust.
|
ToastyFS is a distributed file system designed for self-hosting, so it aims to be pragmatic, understandable, and robust.
|
||||||
|
|
||||||
𝅘𝅥𝅮 𝅘𝅥𝅮 Now let's get toasty 𝅘𝅥𝅮 𝅘𝅥𝅮
|
You can use ToastyFS to store your files reliably over multiple machines knowing they will be automatically replicated and healed in case of hardware failure.
|
||||||
|
|
||||||
|
⚠️ Note that ToastyFS is still in early development ⚠️
|
||||||
|
|
||||||
|
🎵 Now let's get toasty 🎵
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Cross-platform (runs on Windows and Linux)
|
||||||
|
- Automatic Replication & Self-Healing
|
||||||
|
- Automatic content deduplication: File contents are de-duplicated automatically with content-addressing.
|
||||||
|
- Configurable chunk sizes: Each file can have different chunk size optimized for its use case
|
||||||
|
- Zero dependencies: Pure C implementation with no external libraries
|
||||||
|
|
||||||
|
But ToastyFS is still in early development, so here are the missing features:
|
||||||
|
|
||||||
|
- No master replication
|
||||||
|
- No authentication or encryption
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
ToastyFS is tested by running an in-memory simulation of a cluster with many clients running hundreds of random operations in parallel. The test is run for long periods of times under valgrind or compiled with sanitizers.
|
ToastyFS is tested by running an in-memory simulation of a cluster with many clients running hundreds of random operations in parallel. The test is run for long periods of times under valgrind or compiled with sanitizers.
|
||||||
|
|||||||
@@ -11,6 +11,7 @@
|
|||||||
- Should list scenarios that need testing, like those where chunks would be dropped
|
- Should list scenarios that need testing, like those where chunks would be dropped
|
||||||
- Update DESIGN.txt and the code to remove the chunk list message. The information of chunks
|
- Update DESIGN.txt and the code to remove the chunk list message. The information of chunks
|
||||||
held by chunk servers is now transmitted to the metadata server during state updates
|
held by chunk servers is now transmitted to the metadata server during state updates
|
||||||
|
- clean up the replication factor business
|
||||||
|
|
||||||
Roadmap:
|
Roadmap:
|
||||||
[ ] Complete all endpoints
|
[ ] Complete all endpoints
|
||||||
|
|||||||
Reference in New Issue
Block a user