clerie/fieldpoc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Moving installation docs to seperate directory

Browse Source
This commit is contained in:
clerie
2023-10-14 18:24:16 +02:00
parent 498a429c8d
commit 190d89eb2c
8 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/install/configure.md Normal file
View File

@@ -0,0 +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 = "/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.

18
docs/install/hardware.md Normal file
View File

@@ -0,0 +1,18 @@
# Required hardware
These are the hardware requirements for a minimal working system.
## DECT Antenna
FieldPOC is automation around the management API of Mitel DECT systems.
So you need to have a [Mitel RFP 3rd gen](https://howto.dect.network/#hardware-rfp-generations).
Our development setup currently uses an RFP 43 WLAN.
## Powering the Antenna
The RFP gets powered using PoE, so make sure you have a **PoE Injector**
## Telephony Server
The telephony server should be a x84 64bit computer with two Gigabit Ethernet RJ45 ports.
In out case we use an APU Board, but it doesn't really matter.

16
docs/install/index.md Normal file
View File

@@ -0,0 +1,16 @@
# Installation overview
FieldPOC requires a bunch of components to work together.
We guide you through the setup of a minimal working system.
Follow it in order and you will end up with a working setup.
1. Required hardware
2. Install NixOS
3. Install FieldPOC
4. Configure networking
5. Configure FieldPOC
6. Prepare RFP
7. Setup OMM
8. Have DECT
There are plenty of options to extend the system and we try to document them in the following sections.

55
docs/install/network.md Normal file
View File

@@ -0,0 +1,55 @@
# Configure networking
The hardware should have two network interfaces, so we can use one interface to connect the telephony server to the internet and access for management.
The other network interface is used to connect to the DECT antenna.
## Management and internet interface
You can configure the interface for management and internet access how you like it.
Usually leaving it with doing DHCP is totally find.
## Interface for DECT antenna
The telephony server is acting as a router for the DECT antenna.
The network interface used in this example is called `enp3s0`.
Replace it with the name of your own interface.
Assign a static IP address to the interface:
```
networking.interfaces.enp3s0.ipv4.addresses = [ { address = "10.42.132.1"; prefixLength = 24; } ];
```
Phoning over the internet involves weird protocols.
Because configuring firewalls for that use-case is hard, we disable the NixOS firewall on that interface.
We can do that safely, as only the DECT antenna is connected to it and we have to trust it anyway.
```
networking.firewall.trustedInterfaces = [ "enp3s0" ];
```
### Configure DHCP server
FieldPOC ships with some configuration wrapper that helps setting up the DHCP server required for the DECT antennas.
```
services.fieldpoc = {
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";
}
];
};
};
```

25
docs/install/nixos.md Normal file
View File

@@ -0,0 +1,25 @@
# Install NixOS
To coordinate all the different components, FieldPOC is packaged with NixOS.
Follow [the official installation guide](https://nixos.org/manual/nixos/stable/#ch-installation) to install NixOS on you telephony server.
You can use the minimal installer, as we don't need graphical user interface.
## Add FieldPOC packages
FieldPOC is provided as a Flake.
Add the following inputs to your `flake.nix`:
```
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
```

67
docs/install/omm.md Normal file
View File

@@ -0,0 +1,67 @@
# Setup OMM
OMM stands for Open Mobility Manager.
It is there to manage multiple RFPs.
## Designate OMM
The OMM is a pice of software that can be hosted stand-alone or you can designate a RFP to be the OMM.
In setups operating FieldPOC it is usually totally fine and recommended to just designate a RFP to be the OMM.
RFPs automatically host the OMM when they receive their own IP address in the OMM field via DHCP.
## Management interface
The OMM exposes a web interface at their IP address.
It is reachable via its IP address, port 443.
## Setup
When using the OMM the first time, some initial tasks have to be done.
This only apply on a fresh factory reset RFP.
You get a login screen without a PARK shown.
You can login with the credentials `omm` and password `omm`.
Afterwards you get propted to accept the EULA.
### Login credentials
You get asked to set a new password for user `omm`.
Set a new password.
Make sure to leave password aging to `None`.
Next you get ask to set a password for the `root` user too.
It is used to access the OMM via SSH.
Set a password for it too.
### Activate license
You can configure many things, but the OMM does not really do anything without a license.
Go to tab `System` and then `System Settings` and find row `PARK`.
Load PARK file as explained in [howto.dect.network](https://howto.dect.network/#system-settings).
Wait for OMM restarting.
### SIP Settings
Connect the OMM with the SIP server of FieldPOC.
Go to tag `System`, then `SIP` and find rows `Proxy server` and `Registrar server`.
Fill in the IPv4 address of the DECT network interface of the FieldPOC server (`10.42.132.1` in the example).
Save using the `OK` button.
### DECT devices subscription
This enables DECT devices to connect to the phone system.
Go to tab `SIP Users/Devices`.
Set `DECT authentication code` to `0000`.
Set checkbox in row `Auto-create on subscription`.
Change the drop down in row `Subscription` to `Subscription`.
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.

11
docs/install/rfp.md Normal file
View File

@@ -0,0 +1,11 @@
# Prepare RFP
Before adding an RFP to your FieldPOC setup do a [software update](https://howto.dect.network/#software-update) to **SIP-DECT 8.1** and [factory reset them](https://howto.dect.network/#factory-reset).
## Connecting RFP
Connect the RFP with the PoE injector and then with the network interface of your telephony server that carries the network for the DECT antennas.
RFPs will take a while to boot.
First only one LED will glow.
After a while more will add.