summaryrefslogtreecommitdiff
path: root/machines/xnet/README
diff options
context:
space:
mode:
Diffstat (limited to 'machines/xnet/README')
-rw-r--r--machines/xnet/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/machines/xnet/README b/machines/xnet/README
new file mode 100644
index 0000000..ab1c28c
--- /dev/null
+++ b/machines/xnet/README
@@ -0,0 +1,18 @@
+xnet
+====
+
+Base configuration for any machines running a standard xnet
+configuration.
+
+Notable features:
+
+ - Root filesystem running in RAM
+ - Automated ZFS partitioning of disk
+ - Hardened SSH and web services
+
+Usage
+=====
+
+The entire module is exposed from the top-level flake as a nixosModule,
+but it changes too often to be considered stable. Options are made
+available when imported under the 'xnet' attribute set.