ref: 5804c2160183d26096b399632125eca01e28cb8f
parent: 8014cb752602bd3ccff60b7621e742854901d5da
author: Runxi Yu <runxiyu@umich.edu>
date: Mon Jan 19 10:27:11 EST 2026
README: Document architectual considerations
--- a/README.md
+++ b/README.md
@@ -64,6 +64,17 @@
**Note:** go-git is expected to perform much better after
[storage: filesystem/mmap, Add PackScanner to handle large repos](https://github.com/go-git/go-git/pull/1776).
+## Architectural considerations
+
+It is important to realize that Furgit, and performant Git implementations in
+general, heavily rely on using memory mappings of packfiles, and assume
+relatively predictable fault handling behavior. Therefore, in distributed
+systems, we strongly advise *not* using Furgit on top of distributed network
+filesystems such as CephFS or NFS; instead, consider solutions where redundancy
+and distributions belong *above* the Git layer, such as using a set of Git
+nodes each running Furgit/etc. on local repositories, then using an RPC
+protocol over it.
+
## Dependencies
* The standard library
--
⑨