go-nfs

golang NFSv3 server

Github星跟踪图

Golang Network File Server

NFSv3 protocol implementation in pure Golang.

Current Status:

  • Minimally tested
  • Mounts, read-only and read-write support

Usage

The most interesting demo is currently in example/osview.

Start the server
go run ./example/osview ..

The local folder at . will be the initial view in the mount. mutations to metadata or contents
will be stored purely in memory and not written back to the OS. When run, this
demo will print the port it is listening on.

The mount can be accessed using a command similar to
mount -o port=<n>,mountport=<n> -t nfs localohst:/mount <mountpoint>.

API

The NFS server runs on a net.Listener to export a file system to NFS clients.
Usage is structured similarly to many other golang network servers.

import (
   	"github.com/go-git/go-billy/v5/memfs"

	nfs "github.com/willscott/go-nfs"
	nfshelper "github.com/willscott/go-nfs/helpers"
)

listener, _ := net.Listen("tcp", ":0")
fmt.Printf("Server running at %s\n", listener.Addr())

mem := memfs.New()
f, err := mem.Create("hello.txt")
f.Write([]byte("hello world"))
f.Close()

handler := nfshelper.NewNullAuthHandler(mem)
cacheHelper := nfshelper.NewCachingHandler(handler)
nfs.Serve(listener, cacheHelper)

Notes

  • Ports are typically determined through portmap. The need for running portmap
    (which is the only part that needs a privileged listening port) can be avoided
    through specific mount options. e.g.
    mount -o port=n,mountport=n -t nfs host:/mount /localmount

  • This server currently uses billy to
    provide a file system abstraction layer. There are some edges of the NFS protocol
    which do not translate to this abstraction.

    • NFS expects access to an inode or equivalent unique identifier to reference
      files in a file system. These are considered opaque identifiers here, which
      means they will not work as expected in cases of hard linking.
    • The billy abstraction layer does not extend to exposing uid and gid
      ownership of files. If ownership is important to your file system, you
      will need to ensure that the os.FileInfo meets additional constraints.
      In particular, the Sys() escape hatch is queried by this library, and
      if your file system populates a syscall.Stat_t
      concrete struct, the ownership specified in that object will be used.
  • Relevant RFCS:
    5531 - RPC protocol,
    1813 - NFSv3,
    1094 - NFS

主要指标

概览
名称与所有者willscott/go-nfs
主编程语言Go
编程语言Go (语言数: 1)
平台
许可证Apache License 2.0
所有者活动
创建于2020-04-25 17:58:20
推送于2025-02-06 10:48:52
最后一次提交2025-02-06 12:45:01
发布数3
最新版本名称v0.0.3 (发布于 2025-02-06 11:46:42)
第一版名称v0.0.1 (发布于 )
用户参与
星数732
关注者数10
派生数78
提交数192
已启用问题?
问题数49
打开的问题数4
拉请求数69
打开的拉请求数5
关闭的拉请求数16
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?