Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schille/bold-nfs
Bold is a v4-series NFS server written in async Rust based on Tokio.
https://github.com/schille/bold-nfs
nfs nfs-client nfs-server rust-lang tokio-rs
Last synced: 2 months ago
JSON representation
Bold is a v4-series NFS server written in async Rust based on Tokio.
- Host: GitHub
- URL: https://github.com/schille/bold-nfs
- Owner: Schille
- License: mit
- Created: 2024-07-23T07:14:16.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T19:18:44.000Z (3 months ago)
- Last Synced: 2024-09-17T23:52:42.890Z (3 months ago)
- Topics: nfs, nfs-client, nfs-server, rust-lang, tokio-rs
- Language: Rust
- Homepage:
- Size: 173 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bold - a Network File System (NFS) server
This is **Bold**. A version [4-series compatible NFS](https://en.wikipedia.org/wiki/Network_File_System#NFSv4) server written in async Rust based on [Tokio](https://docs.rs/tokio/latest/tokio/).
> NFS is the most widely used network file system for production server workloads.
(This is a **Bold** claim)
## Goals
Bold's design goals are:
1) simplicity
2) robustness
3) portability
4) extendability
5) performance
Anti goals include complicated compile-time computations, such as macro or type trickery.
## Demo and testing
There is a binary `bold-mem` (in /exec), which reads in a
YAML file and serves this as in-memory file system.
On Linux:
```yaml
# bold-mem/memoryfs.yaml
name:
contents:
- !Dir
name: home
contents:
- !Dir
name: user
contents:
- !File
name: file1
contents: |
This is the content of file1
- !File
name: file2
contents: |
This is the content of file2
```
You can compile and run it from the repo:
1) `cargo run -p bold-mem -- --debug exec/memoryfs.yam`
(optionally, you can enable the `--debug` flag)
2) Open another terminal
3) `mkdir /tmp/demo`
4) `sudo mount.nfs4 -n -v -o fg,soft,sec=none,vers=4.0,port=11112 127.0.0.1:/ /tmp/demo`
5) `ls /tmp/demo/`, `cat /tmp/demo/home/user/file1`
(have a look around in your mounted file system)
6) Copy files from your local computer into the mounted file system and retrive it back
7) Don't forget to unmount `sudo umount /tmp/demo`, before stopping `bold-mem`
## State of implementation
### Version 4.0
- **WIP**
### Version 4.1
- **Not started**
### Version 4.2
- **Not started**
## Importand RFC for the implementation
- [XDR: External Data Representation Standard](https://datatracker.ietf.org/doc/html/rfc4506)
- [Network File System (NFS) Version 4 Protocol](https://datatracker.ietf.org/doc/html/rfc7530)
- [Network File System (NFS) Version 4 Minor Version 1 Protocol](https://datatracker.ietf.org/doc/html/rfc5661)
- [Network File System (NFS) Version 4 Minor Version 2 Protocol](https://datatracker.ietf.org/doc/html/rfc7862)
## License
Distributed under the MIT license. See `LICENSE` for more information.