From cc43776e6dd7eb94962e9f23b8e8282d34597a75 Mon Sep 17 00:00:00 2001
From: clerie <git@clerie.de>
Date: Sun, 18 Jun 2023 22:19:30 +0200
Subject: [PATCH] Add some docs

---
 docs/nixos.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/omm.md   | 29 +++++++++++++++++++++++++++++
 2 files changed, 80 insertions(+)
 create mode 100644 docs/nixos.md
 create mode 100644 docs/omm.md

diff --git a/docs/nixos.md b/docs/nixos.md
new file mode 100644
index 0000000..375eaa0
--- /dev/null
+++ b/docs/nixos.md
@@ -0,0 +1,51 @@
+# NixOS deployment
+
+## Add flake
+
+Add input:
+
+```
+inputs.fieldpoc.url = "git+https://git.clerie.de/clerie/fieldpoc.git";
+```
+
+Do not set the FielPOC flake to follow your nixpkgs input as this messes with the dependencies of FieldPOC.
+Especially the Python modules are incredibly dependent on specific version combinations to properly run.
+
+Add input modules to your system:
+
+```
+fieldpoc.nixosModules.default
+```
+
+## Use module
+
+```
+networking.interfaces.enp3s0.ipv4.addresses = [ { address = "10.42.132.1"; prefixLength = 24; } ];
+networking.firewall.trustedInterfaces = [ "enp3s0" ];
+
+services.fieldpoc = {
+  enable = true;
+  ommIp = "10.42.132.2";
+  ommUser = "omm";
+  ommPasswordPath = pkgs.writeText "ommpassword" "rfpL43wlan";
+  sipsecretPath = pkgs.writeText "sipsecret" "c1e0aba8e0fc3ed3";
+  dhcp = {
+    enable = true;
+    interface = "enp3s0";
+    subnet = "10.42.132.0/24";
+    pool = "10.42.132.200 - 10.42.132.250";
+    router = "10.42.132.1";
+    dnsServers = "10.42.10.8";
+    omm = "10.42.132.2";
+    reservations = [
+      {
+        name = "omm";
+        macAddress = "00:30:42:1b:8c:7c";
+        ipAddress = "10.42.132.2";
+      }
+    ];
+  };
+};
+```
+
+
diff --git a/docs/omm.md b/docs/omm.md
new file mode 100644
index 0000000..ada7b5d
--- /dev/null
+++ b/docs/omm.md
@@ -0,0 +1,29 @@
+# OMM
+
+## Setup
+
+### Login credentials
+
+- Set password for login `omm`
+- Set password for login `root`
+
+### PARK
+
+1. Go to `System` -> `System Settings` and find row `PARK`.
+2. Load PARK file as explained in [howto.dect.network](https://howto.dect.network/#system-settings).
+
+### SIP Settings
+
+1. Go to `System` -> `SIP` and find rows `Proxy server` and `Registrar server`.
+2. Fill in the IPv4 address of the DECT network interface of the FieldPOC server.
+3. Save using the `OK` button.
+
+### Subscription
+
+1. Go to `SIP Users/Devices`.
+2. Set checkbox in row `Auto-create on subscription`.
+3. Change the drop down in row `Subscription` to `Subscription`.
+4. Save using the `OK` button.
+
+Sometimes the value in row `Subscription` changes to `Off` randomly.
+If you can't subscribe new devices, make sure to check this option.