From 498a429c8db8c4eba2949365d68c185f53c6e7e2 Mon Sep 17 00:00:00 2001 From: clerie Date: Sat, 14 Oct 2023 18:19:49 +0200 Subject: [PATCH] Explain FieldPOC setup config --- docs/configure.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/configure.md b/docs/configure.md index 4f8cb25..336d691 100644 --- a/docs/configure.md +++ b/docs/configure.md @@ -1,11 +1,21 @@ # Configure FieldPOC +To enable FieldPOC on the system just add this config. + ``` services.fieldpoc = { enable = true; ommIp = "10.42.132.2"; ommUser = "omm"; - ommPasswordPath = pkgs.writeText "ommpassword" "rfpL43wlan"; - sipsecretPath = pkgs.writeText "sipsecret" "c1e0aba8e0fc3ed3"; + ommPasswordPath = "/var/src/secrets/fieldpoc/ommpassword"; + sipsecretPath = "/var/src/secrets/fieldpoc/sipsecret"; }; ``` + +- `ommIp` is the IP address of your OMM. +- `ommUser` is the user account that FieldPOC uses to access the OMM. You usually want to set this to `omm`. +- `ommPasswordPath` is the path to a file containing the password for the OMM user. This password is configured when [setting up the OMM](omm.md#login-credentials). + +- `sipsecretPath` is a path to a file containing a 16 characters hex string. FieldPOC is generating internal SIP accounts for each DECT user. So nobody can hijack these accounts, this secret is used as a seed for generating passwords for these accounts. + +When enabling the FieldPOC module a correctly configured Yate service is added to your system.