Add some docs

This commit is contained in:
clerie 2023-06-18 22:19:30 +02:00
parent 3519bdcec4
commit cc43776e6d
2 changed files with 80 additions and 0 deletions

51
docs/nixos.md Normal file
View File

@ -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";
}
];
};
};
```

29
docs/omm.md Normal file
View File

@ -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.