GhostFS Documentation

GhostFS is a FUSE-based distributed filesystem that serves any filesystem over the network using Cap'n Proto RPC.

What is GhostFS?

GhostFS lets you mount a remote directory as if it were a local filesystem. Files are accessed over the network transparently — your applications don't need to know anything about the network.

Key Features

• High Performance — Write-back caching and read-ahead prefetch for near-local speeds
• Secure — Optional client-side encryption (XChaCha20-Poly1305), TLS transport
• Simple — Single binary, minimal configuration
• Production Ready — Token authentication, sharing, SQLite persistence

Quick Start

# On the server
ghostfs server --root /data --bind 0.0.0.0

# On the client
ghostfs mount /mnt/remote --host server.local --user alice --token mytoken

Next Steps

• Quickstart Guide — Get up and running in 5 minutes
• Installation — Platform-specific installation instructions
• CLI Reference — Complete command reference