aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorChristopher Baines <mail@cbaines.net>2021-12-05 20:06:20 +0000
committerChristopher Baines <mail@cbaines.net>2021-12-05 20:44:58 +0000
commit7e280ca951e8ffa7c86224843075e65266911617 (patch)
tree37e9de0e5b95fe909600724a1736bcf060051e86 /README.org
downloadnar-herder-7e280ca951e8ffa7c86224843075e65266911617.tar
nar-herder-7e280ca951e8ffa7c86224843075e65266911617.tar.gz
Initial commit
Diffstat (limited to 'README.org')
-rw-r--r--README.org14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..c9090be
--- /dev/null
+++ b/README.org
@@ -0,0 +1,14 @@
+-*- mode: org -*-
+
+This is a utility for managing a collection of nars (normalized
+archives, in the context of Guix) along with the corresponding narinfo
+files which contain some signed metadata.
+
+While tasks like publishing local store items as nars is easy with
+tools like =guix publish=, =nar-herder= is aimed at enabling serving
+the same collection of nars from multiple machines at once, including
+moving the nars from machine to machine according to different
+criteria.
+
+A reverse proxy (like nginx) should be used for the actual serving of
+the nars, as well as handling proxying the requests to =nar-herder=.