SaunaFS is a free and open source, distributed POSIX file system inspired by Google File System. Designed to run on commodity hardware, SaunaFS is a high-performance, scalable, and reliable file system that provides high availability, data integrity, fault tolerance, and performance on par with local file systems. It it easy to deploy and manage, and it is designed to be used in a wide range of applications, from small clusters to large data centers.
- Resilient architecture to ensure seamless operation organized into distinct components (Metadata servers, data servers, clients).
- Continuous assured data integrity and verification with CRC data stored within each chunk’s metadata.
- Robust redundancy and enhanced data durability with Reed-Solomon erasure coding when up to two nodes can disappear without service interruption.
- Instant Copy-on-Write Snapshots to implement immutability.
- Data preservation and recovery with instant snapshotting mechanism.
- Fast metadata logging for with support for access time attribute.
- Seamless hardware refresh and expansion without downtime.
Please refer to the Installation Guide for detailed instructions on how to install SaunaFS.
Check the Quick Start guide for a simple setup of SaunaFS on a single machine.
After the Quick Start Guide, for an advanced setup, please refer to the Administration Guide as a starting place.
This section assumes you have the necessary dependencies installed. If not, check the Installation Guide for a list of dependencies (at least for Ubuntu) and a more complete guide for compiling from source.
We use nice to set the building process to a lower priority, so it doesn't
hog memory and CPU resources. We also set -j to the number of cores in your
system to speed up the build process. Note that setting -j without nice can
lead to the system running out of memory/hanging.
git clone https://github.com/leil-io/saunafs.github
cd saunafs
mkdir build
cd build
cmake ..
nice -n 16 make -j$(nproc)There are 2 types of documentation available:
- Online documentation for a general overview
- Man pages for specific commands and service configuration
Currently, we do not accept outside contributions. We still allow (and encourage) pull requests, but without approval they won't be merged at the moment. We are currently working on creating a system to allow seamless pull requests outside with as little fuss as possible. See this issue for more details.
See the Contributing Guide for detailed information on how to contribute to SaunaFS.
The Developer Guide is a good starting point for how to setup a development environment and run tests.
Join our Slack community to connect with fellow SaunaFS enthusiasts, developers, and users. In our Slack channels, you can:
- Ask Questions: Seek guidance, share your experiences, and ask questions related to SaunaFS.
- Discuss Ideas: Engage in discussions about new features, improvements, and best practices.
- Receive Updates: Stay informed about SaunaFS developments, releases, and events.
Join us and be part of the discussion.
| Method | Link |
|---|---|
| contact@saunafs.com | |
| 🌐 Web | https://saunafs.com |
Thank you for your help.
The SaunaFS Team.
