From 83e132d9c2dc43410e2d1d13e67b4bd4ba2020d0 Mon Sep 17 00:00:00 2001
From: rnhmjoj <rnhmjoj@inventati.org>
Date: Wed, 10 Aug 2022 17:28:30 +0200
Subject: [PATCH] add a README

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9dd2bf3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# Maxwell configuration
+
+The NixOS configuration of Maxwell
+
+## Switching configuration
+
+1. Mount remotely the secrets directory
+
+   `$ ssh -A maxwell sshfs wigfrid.ydns.eu:$PWD $PWD -o allow_other`
+
+2. Run nixos-rebuild
+
+   `$ nixos-rebuild test -I nixos-config=configuration.nix
+      --target-host maxwell --use-remote-sudo`
+
+3. Unmount the secrets directory
+
+   `ssh -A maxwell fusemount -u $PWD`
+
+## Testing changes
+
+1. Build a VM
+
+   `$ nixos-rebuild build-vm -I nixos-config=testing.nix`
+
+2. Change the open files limit
+
+   `$ ulimit -n 90000` 
+
+3. Run the VM without internet (to avoid a mess)
+
+   `$ unshare -nc result/bin/run-maxwell-vm`