docs: document how to run an instance

1 files changed, 44 insertions, 0 deletions

diff --git a/docs/running.md b/docs/running.md
new file mode 100644
index 0000000..8310c99
--- /dev/null
+++ b/docs/running.md
@@ -0,0 +1,44 @@
+# Running an instance
+
+## Requirements:
+
+-   400MiB disk space
+-   <100MiB RAM
+
+This [repository](https://git.alanpearce.eu/searchix) (or its [sourcehut mirror](https://git.sr.ht/~alanpearce/searchix)) is importable as a flake containing a NixOS module.
+
+```nix
+{
+  inputs.searchix.url = "git+https://git.alanpearce.eu/searchix";
+  # or
+  inputs.searchix.url = "sourcehut:~alanpearce/searchix";
+
+  outputs = { self, nixpkgs, searchix }: {
+    nixosConfigurations.<hostname> = nixpkgs.lib.nixosSystem {
+      modules = [
+        searchix.modules.web
+      ];
+    };
+  };
+}
+```
+
+This will then expose the following schema:
+
+```nix
+services.searchix = {
+  enable = true;
+# user = "searchix";
+# group = "searchix";
+# homeDir = "/var/lib/searchix";
+# settings = {
+#   web = {
+#     port = 51313;
+#     listenAddress = "localhost";
+#     baseURL = "http://localhost:51313";
+#   };
+# };
+};
+```
+
+Where `settings` complies with [NixOS RFC 42 (settings options)](https://github.com/NixOS/rfcs/pull/42); see the [default values](../defaults.toml) for reference.