ZeroFS Documentation

ZeroFS serves S3-compatible buckets as POSIX filesystems over NFS and 9P, and as block devices over NBD. NFS and 9P need nothing installed on the client because the OS already ships support; a bundled FUSE client mounts without root. The server runs in userspace, with no kernel modules. CI compiles the Linux kernel on ZeroFS mounts on every change.

What ZeroFS does

ZeroFS keeps primary data in S3 rather than on local disk. Every block is compressed, then encrypted with XChaCha20-Poly1305 before upload; there is no unencrypted mode. The maximum filesystem size is 16 EiB. Databases, code builds, and VM boot disks run directly against the bucket.

Guides

Encryption & Security

Learn how ZeroFS encrypts your data with XChaCha20-Poly1305.

Read more

Configuration

Configure S3 backends, caching, and network settings.

Read more

Troubleshooting

Debug common issues and understand error messages.

Read more

Advanced Use Cases

Build geo-distributed storage and tiered architectures.

Read more

Resources

Quickstart

Get up and running with ZeroFS in minutes. Install, configure, and mount your first S3 filesystem.

NFS File Access

Mount ZeroFS as a network filesystem on any OS. Access files with standard POSIX operations.

9P File Access

High-performance file access on Linux using the 9P protocol with advanced caching options.

NBD Block Devices

Create raw block devices backed by S3. Perfect for ZFS pools, databases, or any filesystem.

Was this page helpful?